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: use either Hardfork or Network upgrade consistently across docs #1676

Closed
jcstein opened this issue Aug 21, 2024 · 11 comments · Fixed by #1711
Closed

docs: use either Hardfork or Network upgrade consistently across docs #1676

jcstein opened this issue Aug 21, 2024 · 11 comments · Fixed by #1711
Labels
P0 Top priority

Comments

@jcstein
Copy link
Member

jcstein commented Aug 21, 2024

To clear confusion, use either Hardfork or Network upgrade consistently throughout the documentation. This is also related to #1675.

@rootulp
Copy link
Contributor

rootulp commented Aug 21, 2024

Relevant:

TLDR: there isn't team alignment on the decision to use "hard fork" or "network upgrade" so we need to build alignment before we implement this.

@jcstein
Copy link
Member Author

jcstein commented Aug 21, 2024

Thank you for adding the context! Yep, acknowledging that we'll need to align here first.

@jcstein
Copy link
Member Author

jcstein commented Aug 22, 2024

Voting on poll is leaning toward "Network upgrade" 14-1 https://celestia-team.slack.com/archives/C01JZFUPG48/p1724260139073369

@rootulp
Copy link
Contributor

rootulp commented Aug 26, 2024

I'm in favor of network upgrade.

When we address this issue, we should try to avoid breaking existing links to the docs. Or if we break the links, we should try to fix them. For example the v2.0.0 release notes link to Lemongrass hardfork.

@jcstein
Copy link
Member Author

jcstein commented Aug 26, 2024

Good call out. Do you think it would be best practice to leave "Lemongrass hardfork" as is? So as to not break things for that, and going forward, use Network upgrade?

@rootulp
Copy link
Contributor

rootulp commented Aug 26, 2024

I'm fine with renaming "Lemongrass hardfork" => "Lemongrass network upgrade" if we add a redirect or fix links

@jcstein
Copy link
Member Author

jcstein commented Aug 26, 2024

While it is possible, it still feels a little jank, because you have to leave an old page up still. This is the cleanest way in Vitepress to do redirects that I know of: https://github.com/celestiaorg/docs/pull/1542/files

@jcstein jcstein added the P0 Top priority label Aug 26, 2024
@rootulp
Copy link
Contributor

rootulp commented Aug 26, 2024

I just tried two alternative way to configure redirects:

  1. router.addRoute
  2. rewrites

but neither worked so agreed that it's kinda jank

@jcstein
Copy link
Member Author

jcstein commented Aug 26, 2024

yeah, I'm on the fence about what to do so will think about this

#1552 reverted #1542 pretty quickly bc it was so jank 😅

@jcstein
Copy link
Member Author

jcstein commented Sep 16, 2024

I plan to implement this after v2 is live this week

@jcstein
Copy link
Member Author

jcstein commented Sep 16, 2024

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

Successfully merging a pull request may close this issue.

2 participants