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

Publish documentation on gh-pages branch #1753

Open
dstaley opened this issue Nov 2, 2019 · 2 comments
Open

Publish documentation on gh-pages branch #1753

dstaley opened this issue Nov 2, 2019 · 2 comments
Assignees
Labels
stale For marking issues as stale. Labeled issues will be closed soon if label is not removed.

Comments

@dstaley
Copy link
Member

dstaley commented Nov 2, 2019

Right now both kinto-http.js and kinto.js use doc.esdoc.org to publish their documentation. ESDoc is, unfortunately, not very TypeScript friendly, so I've been planning on switching over to TypeDoc. However, we'll need a place to host the documentation.

Currently, the gh-pages branch contains the demo for the two projects. I propose that we publish the TypeDoc generated documentation to the gh-pages branch using a GitHub Action when we tag a non-pre-release from master. I haven't looked into it yet, but I'm fairly sure we could still host the demo as a part of the generated TypeDoc documentation.

@leplatrem What do you think?

@dstaley dstaley self-assigned this Nov 2, 2019
@leplatrem
Copy link
Contributor

leplatrem commented Nov 4, 2019

Sounds good!

We can do something with folders too I guess... (eg. https://kinto.github.io/kinto-http.js/demo/)

@dstaley
Copy link
Member Author

dstaley commented Nov 14, 2019

Adding a note here so I don't lose it: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/entrypoint.sh

While we could use someone else's action, I'd prefer to keep a copy of the script in the repo so we know it's not doing anything nefarious.

@dstaley dstaley transferred this issue from Kinto/kinto-http.js Apr 4, 2022
@alexcottner alexcottner added the stale For marking issues as stale. Labeled issues will be closed soon if label is not removed. label Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale For marking issues as stale. Labeled issues will be closed soon if label is not removed.
Projects
None yet
Development

No branches or pull requests

3 participants