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

Allow for stable to be on a rolling release. #7219

Open
Daltz333 opened this issue Jun 23, 2020 · 7 comments
Open

Allow for stable to be on a rolling release. #7219

Daltz333 opened this issue Jun 23, 2020 · 7 comments
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@Daltz333
Copy link

So I have an interesting problem.

My project (frc-docs) has a stable release (2020 tag) that is based yearly, as an archival system. We want users to view the year specific documentation as don't want them to accidentally view documentation for features that are now available yet. Here comes the tricky part. Starting in November is when we make those features live. I'd like to be able to push a commit, and have that change live on stable without having to create a tag. Currently switching between latest and stable breaks links for websites and users.

Suggestions are welcome

@stsewd
Copy link
Member

stsewd commented Jul 2, 2020

Not sure If I understood this completely.

You have docs.com/en/2020 (stable points to it), and you also have master (latest points to master). Now in november, you want to stable point to master?

We are also planning into have more flexibility in marking other versions as stable/latest #5319

@stsewd stsewd added Needed: more information A reply from issue author is required Support Support question labels Jul 2, 2020
@Daltz333
Copy link
Author

Daltz333 commented Jul 2, 2020

Yep!

@no-response no-response bot removed the Needed: more information A reply from issue author is required label Jul 2, 2020
@stsewd
Copy link
Member

stsewd commented Jul 2, 2020

So, to what version would latest point to after that?

@Daltz333
Copy link
Author

Daltz333 commented Jul 2, 2020

latest would likely be unused until when we archive the next release (2021)

  • November (switch from latest to stable as rolling releases)
  • May (stable is fixed to our yearly tag, latest is now rolling releases)

Where stable is the default prefix. We just don't want to constantly be switching from
https://docs.wpilib.org/en/stable
https://docs.wpilib.org/en/latest

@Daltz333
Copy link
Author

@stsewd I think a potential implementation would be for automation rules to be applied to commits.

Have a commit update/activate a specific version on RTD.

Then it would be easy to

  • Match: Any Commit
  • Version Type: Existing Version
  • Version: Stable
  • Action: Update

@stsewd
Copy link
Member

stsewd commented Jul 21, 2020

Don't think we may want to add automation rules for commits (at least for now), but when we have the feature for marking any version as stable, it would likely be added in the api v3, so you can make use of that (and the option will be available from the dashboard as well).

Another solution, but not sure if works for you, is to create a branch named stable, this will remove the rtd's stable, but still sort that version like it does with stable IIRC

@Daltz333
Copy link
Author

Hm. Its less than perfect, but it'll due for now. I'd like to keep this issue open as a feature request.

@stsewd stsewd added Feature New feature Needed: design decision A core team decision is required Improvement Minor improvement to code and removed Support Support question Feature New feature labels Jul 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

2 participants