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

Versioned documentation #273

Open
josecelano opened this issue Jun 10, 2022 · 0 comments
Open

Versioned documentation #273

josecelano opened this issue Jun 10, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@josecelano
Copy link
Member

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 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:

  1. Publish documentation only when someone pushes to releases\** branches. The problem with this solution is you sometimes publish fixes for old releases.
  2. 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:

  1. We expect to publish new releases immediately after merging into main.
  2. 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.

@da2ce7 @yeraydavidrodriguez

@josecelano josecelano added documentation Improvements or additions to documentation question Further information is requested labels Jun 10, 2022
@josecelano josecelano mentioned this issue Jun 10, 2022
54 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant