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

feat: added release page in docs #6669

Open
wants to merge 1 commit into
base: unstable
Choose a base branch
from

Conversation

jeluard
Copy link
Member

@jeluard jeluard commented Apr 14, 2024

Motivation

Display releases in the documentation

This is a first draft aiming at initiating discussion to figure out what is the best option to share releases.

Capture d’écran 2024-04-14 à 22 23 56

I can see 2 angles:

  • list all binaries per release (above screenshot)
  • list binaries per platform (same as geth)

Copy link

codecov bot commented Apr 14, 2024

Codecov Report

Merging #6669 (4e58e65) into unstable (2d766ca) will increase coverage by 0.13%.
Report is 4 commits behind head on unstable.
The diff coverage is n/a.

Additional details and impacted files
@@             Coverage Diff              @@
##           unstable    #6669      +/-   ##
============================================
+ Coverage     61.67%   61.81%   +0.13%     
============================================
  Files           556      556              
  Lines         58834    59050     +216     
  Branches       1888     1898      +10     
============================================
+ Hits          36288    36502     +214     
  Misses        22505    22505              
- Partials         41       43       +2     

@wemeetagain
Copy link
Member

Since we're starting with just linux x86_64 and arm64 binaries, I think its fine to just group them together like you have now.
We don't need to list the .node files since they are not useful for user download (maybe you just have them there as an example)

@jeluard
Copy link
Member Author

jeluard commented Apr 17, 2024

@wemeetagain Right, I'm using blst repo for those tests which publishes those node files as part of releases.

@jeluard jeluard marked this pull request as ready for review April 26, 2024 20:55
@jeluard jeluard requested a review from a team as a code owner April 26, 2024 20:55
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.

It would make more sense to add an entry to installation page. We don't really need to list older versions (rather version docs) and binaries is just one way to install Lodestar, having a Releases page like this even before Introduction gives a wrong impression.

@philknows
Copy link
Member

I tend to agree with @nflaig here. Binaries are just another installation method and should just have its own section under Installation.

I do like the way you cleanly table the releases here, but we definitely don't need to list all of them. I would maybe only go 5 releases back at most, similar to what we would be doing with docs versions. There should be no reason why (nor should we promote) having people stay more than 5 releases behind. This is a pretty weak assumption on my part and open to other opinions.

@nflaig
Copy link
Member

nflaig commented Apr 27, 2024

should just have its own section under Installation.

What about having a separate page per installation method? We had this previously (before #6134), this makes it easier to read and less overloaded with instructions that are unrelated to each other.

@philknows
Copy link
Member

That is also an option so we can keep various installation methods and their quirks separate from each other. So perhaps:

  • Getting Started
    • Quick Start
    • Installation via Binaries
    • Installation via Docker
    • Installation via NPM (which will literally say don't do this for production - instructions were removed to deter this)
    • Starting a Node (which I would recommend in another PR to move into the "Beacon Node" H1 dropdown.

@nflaig
Copy link
Member

nflaig commented Apr 27, 2024

So perhaps:

or subsections in installation

Starting a Node (which I would recommend in another PR to move into the "Beacon Node" H1 dropdown.

Maybe we need to rethink what should be part of getting started, just having installation in there is also a bit strange

@jeluard
Copy link
Member Author

jeluard commented Apr 29, 2024

It probably makes sense to reconsider this in the context of #6550

@nflaig
Copy link
Member

nflaig commented May 3, 2024

Noticed Lighthouse has same layout for Installation as I had in mind

image

This would also allow to use the page you created in this PR I would assume

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.

None yet

4 participants