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

docs: add versioned docs #20

Merged
merged 2 commits into from
Feb 24, 2023

Conversation

salaxander
Copy link
Contributor

Signed-off-by: Xander Grzywinski xandergr@microsoft.com

Add versioned docs starting with v0.1.x

Closes #15

@salaxander salaxander added the documentation Improvements or additions to documentation label Jan 25, 2023
Copy link
Contributor

@CodeMonkeyLeet CodeMonkeyLeet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just questions for my understanding:

  • Should we be using the v?.?.x versioning name? It looks like once Docusaurus spits out a versioned copy, those are expected to be frozen. If we only want to publish doc versions per minor update, then it feels like we should just do v?.?, which leaves open the possibility that we may publish v?.?.? revision to correct something particularly egregious in the minor version of the docs.

  • Is the intention that the docusaurus versions are locked against the release versions? Just thinking about whether we should integrate the doc versioning with the release automation.

@sozercan
Copy link
Member

+1 on adding to release automation

@salaxander
Copy link
Contributor Author

@sozercan how does Eraser do the release automation? I couldn't find anything in the repo that looked like it tied the docs to newly released versions via automation

@sozercan
Copy link
Member

sozercan commented Feb 7, 2023

@codecov-commenter
Copy link

codecov-commenter commented Feb 9, 2023

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (e37f477) compared to base (6b62ec2).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #20   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           27        27           
=========================================
  Hits            27        27           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@CodeMonkeyLeet CodeMonkeyLeet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks generally good to me, thanks for adding the automation in - see comment about the v0.1.x version though.

website/versions.json Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
website/versions.json Outdated Show resolved Hide resolved
Signed-off-by: Xander Grzywinski <xandergr@microsoft.com>
Signed-off-by: Xander Grzywinski <xandergr@microsoft.com>
Copy link
Contributor

@CodeMonkeyLeet CodeMonkeyLeet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@CodeMonkeyLeet CodeMonkeyLeet merged commit 0a7b367 into project-copacetic:main Feb 24, 2023
ashnamehrotra pushed a commit to ashnamehrotra/copacetic that referenced this pull request Aug 25, 2023
Signed-off-by: Xander Grzywinski <xandergr@microsoft.com>
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

Successfully merging this pull request may close these issues.

[DOC] Add versioned docs
4 participants