[Merged by Bors] - Add automatic docs deployment to GitHub Pages #3535
Conversation
alice-i-cecile
added
A-Meta
|
Great! This will close bevyengine/bevy-website#181. |
|
A message on top could say "Development build docs. Click for the latest release docs", or something like that. Alternatively, we can have a dropdown menu like docs.rs to choose between development and release docs. |
|
Added a sed command that changes the icon out for something more noticeable., and added a header.html shim to force Google not to index, even when linked from other sites. Other search engines should basically stop at the robots.txt. |
|
Before more people go looking: the new icon is coming in bevyengine/bevy-website#234 |
This adds a PNG icon for denoting the development docs made from bevy's `main` branch. Added as suggested in bevyengine/bevy#3535. If it doesn't show up in the diff, this is how it looks right now:  Co-authored-by: Aevyrie Roessler <aevyrie@gmail.com>
|
With bevyengine/bevy-website#234 merged, @mockersf, any other thing that's needed? It's a little hard to notice right now, but it should be enough to distinguish between it and docs.rs. I could add a sticky banner as suggested earlier, but |
|
This should be good to go now. The target domain/url is something that is up to Cart. Maybe it should not live on the website / under a I think the url where it would be deployed without custom domain would be https://bevyengine.github.io/bevy, that could help with having website for release, GitHub for in development? |
Co-authored-by: François <mockersf@gmail.com>
|
Yeah I'm ready to move forward on this. I do think that I think I like the |
|
I agree with the |
|
Cool lets roll with that. I'll get the domain set up. |
|
We might actually need to merge this pr first. Can you update the domain? |
|
bors r+ |
# Objective Partially address #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 #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 #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>
bors
bot
changed the title
# Objective - #3535 introduced deploying docs with an error in sed command ## Solution - fix sed command - make the command cross platform
# Objective - #3535 introduced deploying docs without installing dependencies - https://github.com/bevyengine/bevy/runs/5562769081?check_suite_focus=true ## Solution - copied https://github.com/bevyengine/bevy/blob/6ff17eaab8aad54bcb3d79055846c27ca0251fcc/.github/workflows/ci.yml#L270-L271
# 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>
# Objective - bevyengine#3535 introduced deploying docs with an error in sed command ## Solution - fix sed command - make the command cross platform
# Objective - bevyengine#3535 introduced deploying docs without installing dependencies - https://github.com/bevyengine/bevy/runs/5562769081?check_suite_focus=true ## Solution - copied https://github.com/bevyengine/bevy/blob/6ff17eaab8aad54bcb3d79055846c27ca0251fcc/.github/workflows/ci.yml#L270-L271
# 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>
# Objective - bevyengine#3535 introduced deploying docs with an error in sed command ## Solution - fix sed command - make the command cross platform
# Objective - bevyengine#3535 introduced deploying docs without installing dependencies - https://github.com/bevyengine/bevy/runs/5562769081?check_suite_focus=true ## Solution - copied https://github.com/bevyengine/bevy/blob/6ff17eaab8aad54bcb3d79055846c27ca0251fcc/.github/workflows/ci.yml#L270-L271
This adds a PNG icon for denoting the development docs made from bevy's `main` branch. Added as suggested in bevyengine/bevy#3535. If it doesn't show up in the diff, this is how it looks right now:  Co-authored-by: Aevyrie Roessler <aevyrie@gmail.com>
This adds a PNG icon for denoting the development docs made from bevy's `main` branch. Added as suggested in bevyengine/bevy#3535. If it doesn't show up in the diff, this is how it looks right now:  Co-authored-by: Aevyrie Roessler <aevyrie@gmail.com>
Objective
Partially address #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
mainand pushes a new commit to agh-pages(ordocsbranch).A few smaller additions to better address #407:
bevycrate docs.github.ioThis may require configuration of the
GITHUB_TOKENof the CI to successfully run this.Followup
For this to completely resolve #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".