Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hex docs are broken (not setup?) #83

Open
kenny-evitt opened this issue Oct 6, 2021 · 6 comments
Open

Hex docs are broken (not setup?) #83

kenny-evitt opened this issue Oct 6, 2021 · 6 comments

Comments

@kenny-evitt
Copy link

The HexDocs for this package show "PAGE NOT FOUND":

That's the link for "Online documentation" on the Hex page for this project's package:

If Hex docs were never setup, I'd be willing to submit a PR to do that.

Thanks for the library!

@willemdj
Copy link
Owner

Sorry for the slow response...

I don't know anything about Hex docs. If you could submit a PR that would be very much appreciated!

@kenny-evitt
Copy link
Author

@willemdj Your response was more than prompt enough :)

You're listed as an "owner" for the Hex package [tho see below] along with another Hex user named "b0oh". That other Hex user's profile states that their GitHub user is "dimathemachine", but either that GitHub user has been deleted (or renamed) or their profile is entirely private.

Maybe that user was publishing the Hex packages?

The way to publish docs is to use the rebar plugin for Hex:

With that installed, and after registering and 'logging-in' with a Hex user, docs should be able to be published to HexDocs (the Hex docs site) by running rebar3 hex docs. There's a Hex user with the same name as your GitHub user:

Is that not your user account?

If not, that Hex package might be a (potential) security issue!

@kenny-evitt
Copy link
Author

@willemdj I might be being overly paranoid, but I just reported this to Hex as a possible security issue – given that it seems like you're not publishing this package to Hex yourself. I'm now concerned that someone has published your project to Hex themselves, and maybe tampered with its source code, or inserted malicious code.

Adding some brief info about the Hex package to this project's README would be nice – is it 'official', is it 'unaffiliated', or should people avoid using it completely?

@kenny-evitt
Copy link
Author

@willemdj Sorry – probably not an 'attack'. At least based on the email addresses for both your GitHub user and the Hex user matching.

@kenny-evitt
Copy link
Author

Almost certainly a big nothing burger:

@kenny-evitt
Copy link
Author

Maybe just try running rebar3 hex docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants