You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With that approach, we could have a newer docs version than the latest release, leading to confusion.
I do not think that is a problem for now, since we are using two branches: main and develop. If we release a new version every time we merge a minor change into main the documentation should be synced with the release.
There are other solutions like:
Publish documentation only when someone pushes to releases\** branches. The problem with this solution is you sometimes publish fixes for old releases.
Publish different versions for documentation. I think this is the right solution. We could do it on our own (with gp-pages subfolders) or try to find a third-party solution like this or this.
Anyway, I think we can add this issue to the backlog for the time being because:
We expect to publish new releases immediately after merging into main.
We do not expect big changes between versions.
We could implement this feature in case we have big breaking changes in the future like version 2.0.
We are using GitHub Pages to publish the documentation: https://nautilus-cyberneering.github.io/git-queue/
We deploy a new version every time someone pushes to the
main
branch.With that approach, we could have a newer docs version than the latest release, leading to confusion.
I do not think that is a problem for now, since we are using two branches:
main
anddevelop
. If we release a new version every time we merge a minor change intomain
the documentation should be synced with the release.There are other solutions like:
releases\**
branches. The problem with this solution is you sometimes publish fixes for old releases.Anyway, I think we can add this issue to the backlog for the time being because:
main
.We could implement this feature in case we have big breaking changes in the future like version 2.0.
@da2ce7 @yeraydavidrodriguez
The text was updated successfully, but these errors were encountered: