search

bevyengine / bevy-website

The source files for the official Bevy website
https://bevyengine.org
MIT License
197 stars 341 forks source link

handle multiple versions of the website on GitHub pages #388

Open mockersf opened 2 years ago

mockersf commented 2 years ago

This is a proposal on how to handle multiple versions of the website using GitHub pages. It could be a discussion, but they are not enabled on this repo 🙂

One branch per version

The main branch is for documentation/website of the main branch of Bevyengine. Each version get its own branch, so one for 0.7, one for 0.8, ... When creating a new branch from main, care should be taken to update the version used to refer to Bevy in text, in links, in actions, ...

Branches are mirrored to other repositories

For all branches except main, they are mirrored to another repository on GitHub. There is a setup to do as part of each release: create a new repo, and setup the GitHub action to mirror any push to branches to the corresponding repository. Those repository should not have any issue / PRs / ... They should just deploy their content to GitHub pages. This allows us to work around GitHub limits on pages: one domain per repo, and size limit of pages

Dropdown on the website

So that visitors can select the version they are using. main branch is deployed as version unstable and can now be updated with Bevy instead of waiting for the release for a massive update

IceSentry commented 2 years ago

(about this not being a discussion, cart suggested that we use the discussion on the main bevy repo and make sure to use the website tag)

Is the goal of this to have essentially a new book version for each release of bevy? I'm not sure why we would need a completely separate site, with everything duplicated (assets, examples, feature showcase, blogs, etc...) for each version of bevy and I even think this should be avoided just so people don't stumble on outdated information. Maybe in a few years when bevy is more stable, but right now I'm not sure that's a good idea.

mockersf commented 2 years ago

(about this not being a discussion, cart suggested that we use the discussion on the main bevy repo and make sure to use the website tag)

Is the goal of this to have essentially a new book version for each release of bevy? I'm not sure why we would need a completely separate site, with everything duplicated (assets, examples, feature showcase, blogs, etc...) for each version of bevy and I even think this should be avoided just so people don't stumble on outdated information. Maybe in a few years when bevy is more stable, but right now I'm not sure that's a good idea.

(about this not being a discussion, cart suggested that we use the discussion on the main bevy repo and make sure to use the website tag)

Right, forgot about that 🤦 I would rather keep this to the website though...

Is the goal of this to have essentially a new book version for each release of bevy? I'm not sure why we would need a completely separate site, with everything duplicated (assets, examples, feature showcase, blogs, etc...) for each version of bevy and I even think this should be avoided just so people don't stumble on outdated information. Maybe in a few years when bevy is more stable, but right now I'm not sure that's a good idea.

Long term, yes the goal is to have a book for each version, which could be quite useful when Bevy starts having users who are not able to follow each updates. Short term, it will probably be just two versions, last release and current main.