Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

Host java- and scaladoc on Github Pages #92

Closed
4 tasks done
J0B10 opened this issue Jul 18, 2019 · 2 comments
Closed
4 tasks done

Host java- and scaladoc on Github Pages #92

J0B10 opened this issue Jul 18, 2019 · 2 comments
Assignees
Labels
enhancement New feature or request minor Quick to implement
Milestone

Comments

@J0B10
Copy link
Member

J0B10 commented Jul 18, 2019

Description

I'dd like to suggest that we host the scaladoc for the framework and the javadoc of the api on github pages and keep it up to date with the master branch, so that plugin developers can easily use it and we can reference it on github pages.

Github Pages has the advantage over hosting on a private webserver that every contributor with push acces to the repo can update the documentation by pushing to the gh-pages branch.

It also allows everybody to create a local copy by just cloning the branch.

I'dd do the following things:

  • Deploy the docs to github pages.
  • (Optional) Setup travis to auto generate the docs and push them

@sebinside could do:

References

https://pages.github.com/
https://help.github.com/en/articles/using-a-custom-domain-with-github-pages

@J0B10 J0B10 added enhancement New feature or request minor Quick to implement labels Jul 18, 2019
@J0B10 J0B10 added this to the pre-alpha 3 milestone Jul 18, 2019
@sebinside sebinside removed their assignment Jul 18, 2019
@J0B10 J0B10 removed their assignment Jul 18, 2019
@J0B10
Copy link
Member Author

J0B10 commented Jul 18, 2019

As it's now automated via travis there is no need for a sbt task.

Repo can be found under https://github.com/codeoverflow-org/chatoverflow-gh-pages

@sebinside
Copy link
Member

sebinside commented Jul 18, 2019

Last open todos:

  • create a readme.md
  • create a simple index.html

@sebinside sebinside self-assigned this Jul 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request minor Quick to implement
Projects
None yet
Development

No branches or pull requests

2 participants