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

Add a stable branch for building docs #812

Closed
caleb-johnson opened this issue Jul 20, 2023 · 8 comments
Closed

Add a stable branch for building docs #812

caleb-johnson opened this issue Jul 20, 2023 · 8 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@caleb-johnson
Copy link
Collaborator

caleb-johnson commented Jul 20, 2023

The serverless docs say they reference the latest version released to pip, as they draw the version # from that release; however, the docs are currently built from the main branch, which means the docs do not reflect the version they say they do.

It would probably be better to have a stable branch from which to build the docs

@psschwei
Copy link
Collaborator

In other projects, we've cut branches for each minor release (e.g. v0.2, v0.3, etc.) and then cherrypicked patches in if we needed to do a dot release. Looking at qiskit-terra, that seems to be how they do it as well.

@psschwei
Copy link
Collaborator

There will probably be a non-trivial amount of updates needed to the CI (which isn't to say we shouldn't do it, just that it might require some thinking around how to implement it)

@psschwei
Copy link
Collaborator

I'd leave it open -- it's something that still needs to be implemented, so this gives us a nice place to track/discuss.

@caleb-johnson caleb-johnson added the documentation Improvements or additions to documentation label Jul 20, 2023
@Tansito
Copy link
Member

Tansito commented Jul 27, 2023

Not 100% directly related but today I started with #764 so we can think in something similar

@IceKhan13 IceKhan13 added this to the 0.4 milestone Aug 1, 2023
@IceKhan13 IceKhan13 modified the milestones: 0.4, 0.7 Sep 1, 2023
@psschwei
Copy link
Collaborator

psschwei commented Oct 3, 2023

Another option might be to move the docs to their own repo

@Tansito
Copy link
Member

Tansito commented Oct 5, 2023

I would not disagree with that option. It would be my preferred one.

@IceKhan13 IceKhan13 modified the milestones: 0.7, 0.8 Oct 31, 2023
@IceKhan13 IceKhan13 modified the milestones: Q4'23, Q1'24 Dec 12, 2023
@psschwei
Copy link
Collaborator

Sounds like the solution is to move to a new repo (xref #1166), so we can probably close this one.

@IceKhan13
Copy link
Member

I think so. Closing

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
Projects
None yet
Development

No branches or pull requests

4 participants