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

chore: prepare for docs versioning #6559

Closed
wants to merge 1 commit into from
Closed

chore: prepare for docs versioning #6559

wants to merge 1 commit into from

Conversation

jeluard
Copy link
Contributor

@jeluard jeluard commented Mar 18, 2024

Motivation

Prepare for future versioning. For now only support one version, and display it in the main toolbar.

Capture d’écran 2024-03-18 à 13 58 10

Fixes #6548

Copy link

codecov bot commented Mar 18, 2024

Codecov Report

Merging #6559 (b92d355) into unstable (4686ad1) will not change coverage.
Report is 4 commits behind head on unstable.
The diff coverage is n/a.

❗ Current head b92d355 differs from pull request most recent head 9a67a0f. Consider uploading reports for the commit 9a67a0f to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##           unstable    #6559   +/-   ##
=========================================
  Coverage     61.39%   61.39%           
=========================================
  Files           556      556           
  Lines         58751    58751           
  Branches       1848     1848           
=========================================
  Hits          36073    36073           
  Misses        22638    22638           
  Partials         40       40           

@jeluard jeluard marked this pull request as ready for review March 18, 2024 14:26
@jeluard jeluard requested a review from a team as a code owner March 18, 2024 14:26
lastVersion: 'current',
versions: {
current: {
label: '1.7.0'
Copy link
Member

Choose a reason for hiding this comment

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

shouldn't this match whats in our packages/cli/package.json?
What is the process for synchronizing this?

@wemeetagain wemeetagain changed the title chore: prepare for versioning chore: prepare for docs versioning Mar 18, 2024
@jeluard
Copy link
Contributor Author

jeluard commented Mar 18, 2024

My bad, my intention was to match the repo versions. Ideally the latest version would be updated via the release scripts.

It's not clear to me when we would want to introduce a new doc version. FWIW, introducing a new doc version requires duplicating the whole doc content in a specific repo (a script can help this process)

Maybe @nflaig can shim in, as was interested with the versioning support.

@nflaig
Copy link
Member

nflaig commented Mar 19, 2024

Maybe @nflaig can shim in, as was interested with the versioning support.

The idea was to have something similar to what teku does https://docs.teku.consensys.io/.

We could always build docs from unstable branch (on each commit), have docs from stable branch as default as we do now, and then just a few previous releases back.

FWIW, introducing a new doc version requires duplicating the whole doc content in a specific repo (a script can help this process)

Previous docs bundle would have to be hosted somewhere, maybe this is possible via github pages, or another source is required. Might wanna check out how teku does it https://github.com/Consensys/doc.teku

@jeluard
Copy link
Contributor Author

jeluard commented Mar 19, 2024

Previous docs bundle would have to be hosted somewhere, maybe this is possible via github pages, or another source is required. Might wanna check out how teku does it https://github.com/Consensys/doc.teku

Sorry I meant in a specific folder, it's fine in current repo/gh-pages hosting. So the repo would ultimately contain multiple copies of the whole documentation, with just a couple changes (see how it looks like for teku).

Maybe we can decide to not introduce doc version per lodestar release, but only introduce new doc version when significant docs changes have been introduced.

@jeluard jeluard mentioned this pull request Mar 21, 2024
8 tasks
@jeluard jeluard requested a review from nflaig April 3, 2024 16:34
Copy link
Member

@nflaig nflaig left a comment

Choose a reason for hiding this comment

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

Will this just show the latest version for now?

@@ -0,0 +1 @@
[]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
[]
[]

@jeluard
Copy link
Contributor Author

jeluard commented Apr 4, 2024

Closing for now. Will address once we have a better idea of what we want.

@jeluard jeluard closed this Apr 4, 2024
@nflaig
Copy link
Member

nflaig commented Apr 4, 2024

Closing for now. Will address once we have a better idea of what we want.

The ideal case would be the same as Teku docs, have unstable / stable, and a few releases back

image

But if that's too much effort to realize it's definitely not that high prio, so can postpone that for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add versioning support to documentation website
3 participants