Skip to content

Publish API docs on GitHub pages #273

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

Merged
merged 1 commit into from
Feb 14, 2019
Merged

Conversation

ashawley
Copy link
Member

I published a bunch of old versions of scala-xml to the gh-pages branch. This updates the README link to the API docs. There's also a prototype script to build docs for a version tag and commit.

@ashawley ashawley merged commit aba89a4 into scala:master Feb 14, 2019
@SethTisue
Copy link
Member

nice!!

two questions:

  • is there release-process documentation that we should add "run admin/api-docs.sh" to?
  • is there stuff on https://www.scala-lang.org we should ask Fabien to actually remove?

@SethTisue
Copy link
Member

SethTisue commented Feb 14, 2019

oh, also, the readme links to 1.1.0, isn't the current version 1.1.1? #277

@ashawley
Copy link
Member Author

I've added notes in the Publishing guide.

@ashawley
Copy link
Member Author

Yeah, we probably could delete copies of the scala-xml docs on www.scala-lang.org.

Could we start with just adding redirects?

Redirect /api/2.11.0/scala-xml/ https://scala.github.io/scala-xml/api/1.0.1/
Redirect /api/2.11.1/scala-xml/ https://scala.github.io/scala-xml/api/1.0.1/
Redirect /api/2.11.2/scala-xml/ https://scala.github.io/scala-xml/api/1.0.2/
Redirect /api/2.11.3/scala-xml/ https://scala.github.io/scala-xml/api/1.0.2/
Redirect /api/2.11.4/scala-xml/ https://scala.github.io/scala-xml/api/1.0.2/
Redirect /api/2.11.5/scala-xml/ https://scala.github.io/scala-xml/api/1.0.3/
Redirect /api/2.11.6/scala-xml/ https://scala.github.io/scala-xml/api/1.0.3/
Redirect /api/2.11.7/scala-xml/ https://scala.github.io/scala-xml/api/1.0.4/
Redirect /api/2.11.8/scala-xml/ https://scala.github.io/scala-xml/api/1.0.4/
Redirect /api/2.11.9/scala-xml/ https://scala.github.io/scala-xml/api/1.0.5/
Redirect /api/2.11.10/scala-xml/ https://scala.github.io/scala-xml/api/1.0.5/
Redirect /api/2.11.11/scala-xml/ https://scala.github.io/scala-xml/api/1.0.5/
Redirect /api/2.11.12/scala-xml/ https://scala.github.io/scala-xml/api/1.0.5/
Redirect /api/2.12.0/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.12.1/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.12.2/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.12.3/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.12.4/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.12.5/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.12.6/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.12.7/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.13.0-M1/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.13.0-M2/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/
Redirect /api/2.13.0-M3/scala-xml/ https://scala.github.io/scala-xml/api/1.0.6/

There's probably a way to write regex versions of the above, but I'm no longer an Apache mod_rewrite wizard.

@SethTisue
Copy link
Member

@fsalvi is this something you could take care of...?

@ashawley ashawley deleted the api-docs branch February 16, 2019 03:57
@fsalvi
Copy link

fsalvi commented Feb 18, 2019

Ok, I added the redirects...

@SethTisue
Copy link
Member

super, thanks Fabien!

@ashawley
Copy link
Member Author

Redirects look good, thanks!

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

Successfully merging this pull request may close these issues.

3 participants