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

Create docs_config.js for Elixir, ExDoc, Hex etc #30

Closed
wojtekmach opened this issue Apr 3, 2019 · 7 comments
Closed

Create docs_config.js for Elixir, ExDoc, Hex etc #30

wojtekmach opened this issue Apr 3, 2019 · 7 comments

Comments

@wojtekmach
Copy link
Member

Ref: hexpm/hexdocs#9

@michallepicki
Copy link
Contributor

Is this issue about adding the master version link to the dropdown?

Is it also about fixing the links to Elixir v1.0.0 - v1.0.3 or is it a separate issue?

@ericmj
Copy link
Member

ericmj commented Apr 3, 2019

I think we should add master to the dropdown based on other discussions. Do you agree @josevalim?

We don't have docs builds for Elixir v1.0.0 - v1.0.3 so we should remove those links from the dropdown.

@wojtekmach
Copy link
Member Author

wojtekmach commented Apr 4, 2019

I actually initially had master in the dropdown (5d2fc6b) but then on https://hexdocs.pm/elixir/master/Kernel.html page the dropdown had both 1.9.0-dev and master which was confusing. When building config I could see that the latest tag is v1.8.1 so the next dev version should be v1.9.0-dev and put that into the list with the link to master, but I'm afraid this could be too clever and error prone.

I've removed links for 1.0.0..1.0.3, good catch!

@josevalim
Copy link
Member

When building config I could see that the latest tag is v1.8.1 so the next dev version should be v1.9.0-dev and put that into the list with the link to master, but I'm afraid this could be too clever and error prone.

This will be fine for a long long long time, at least until we start work on v2.0, so I am ok with it.

@wojtekmach
Copy link
Member Author

@josevalim just so we're clear, you're saying to add 1.9.0-dev (or whatever the latest dev version is) to the config.js or leave things as is?

@michallepicki
Copy link
Contributor

michallepicki commented Apr 4, 2019

@wojtekmach I see. You can take a look at my code here - for people hosting their docs and maintaining their own versions, for convenience and so that things don't break, we're prepending the list with an entry for the current version if it's seemingly missing. The current version name is being read from what was displayed instead of the version dropdown, so indeed for the current master it's v1.9.0-dev.

Looks like having an option v1.9.0-dev is the easy way to go for now, I actually don't mind if it would be called that. We could change my code in ExDoc if we want to display master there

@josevalim
Copy link
Member

leave things as is?

This. :)

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

4 participants