Publish API Documentation for Master Branch #407
Labels
A-Build-System
Related to build systems or continuous integration
C-Docs
An addition or correction to our documentation
C-Feature
A new feature, making something new possible
Comments
|
I suggest avoiding adding to the overhead of the project at this early stage. There's a lot of things like this that are nice, but quickly add up to a lot of infrastructure complexity and maintenance. Rather than serving up API docs for master, I think it would be more healthy to:
|
karroffel
added
A-Build-System
|
I'll buy that. 🙂 👍 |
|
That would be useful (now or eventually). I imagine something like |
|
If the master docs are ever provided on the website, it is of utmost importance search engines do not reference it. Amethyst had a ton of issues with people being misdirected into the wrong documentation. |
aevyrie
pushed a commit
to aevyrie/bevy
that referenced
this issue
Jun 7, 2022
# Objective Partially address bevyengine#407 by setting up automated deployments of `bevy`'s API reference to GitHub Pages. ## Solution Set up a GitHub Actions workflow that builds the docs on every push to `main` and pushes a new commit to a `gh-pages` (or `docs` branch). A few smaller additions to better address bevyengine#407: - A top level redirect was added to take "docs.bevyengine.org" directly to the `bevy` crate docs. - A GitHub Pages CNAME file for supporting a publicly viewable domain instead of `github.io` - A robots.txt file is added to disable all search engine crawlers that respect it from crawling it (avoid having conflicting Google search results) - A .nojekyl file to speed up deployments since there is no Jekyll templating in the output. This may require configuration of the `GITHUB_TOKEN` of the CI to successfully run this. ## Followup For this to completely resolve bevyengine#407, a subdomain of https://bevyengine.org/ needs to be set up to point to the CNAME location. This is initially set to "dev-docs.bevyengine.org". Co-authored-by: Carter Anderson <mcanders1@gmail.com>
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this issue
Feb 1, 2023
# Objective Partially address bevyengine#407 by setting up automated deployments of `bevy`'s API reference to GitHub Pages. ## Solution Set up a GitHub Actions workflow that builds the docs on every push to `main` and pushes a new commit to a `gh-pages` (or `docs` branch). A few smaller additions to better address bevyengine#407: - A top level redirect was added to take "docs.bevyengine.org" directly to the `bevy` crate docs. - A GitHub Pages CNAME file for supporting a publicly viewable domain instead of `github.io` - A robots.txt file is added to disable all search engine crawlers that respect it from crawling it (avoid having conflicting Google search results) - A .nojekyl file to speed up deployments since there is no Jekyll templating in the output. This may require configuration of the `GITHUB_TOKEN` of the CI to successfully run this. ## Followup For this to completely resolve bevyengine#407, a subdomain of https://bevyengine.org/ needs to be set up to point to the CNAME location. This is initially set to "dev-docs.bevyengine.org". Co-authored-by: Carter Anderson <mcanders1@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I was just thinking that it would be useful to have the API documentation for the master branch published to GitHub pages somewhere.
I was going to explain to @lee-orr, a beginner Rustacean, what changes were going to need to happen for #397, but I noticed that some of the API that I was going to point to had not been released yet, which meant that I can't point to the documentation for it. I didn't end up needing it in that case, but it seems like it could be useful.
The text was updated successfully, but these errors were encountered: