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

BREAKING CHANGE: implement docusaurus #144

Open
wants to merge 151 commits into
base: develop
Choose a base branch
from
Open

BREAKING CHANGE: implement docusaurus #144

wants to merge 151 commits into from

Conversation

serhanwbahar
Copy link
Contributor

No description provided.

@serhanwbahar serhanwbahar requested a review from jakubgs June 1, 2023 22:08
@jakubgs
Copy link
Member

jakubgs commented Jun 5, 2023

Is this ready or still a work-in-porgress?

Signed-off-by: Jakub Sokołowski <jakub@status.im>
Copy link
Member

@jakubgs jakubgs left a comment

Choose a reason for hiding this comment

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

If this is a complere revamp of the site you should have just used a complete new branch.

We are completely removing a license, and not replacing it, is that intentional?

I adjusted the Jenkinsfile a bit. Other than that looks good to me.

Copy link
Member

@arnetheduck arnetheduck left a comment

Choose a reason for hiding this comment

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

what's the background of these changes? A massive "BREAKING CHANGE" without any description wiht 200 changed files is .. hard to review?

@arnetheduck
Copy link
Member

from the little information the title gives this should first go onto a staging deployment in a separate branch (no need to wait for a review either, this way)

@jakubgs
Copy link
Member

jakubgs commented Jun 7, 2023

Talk to @amirhouieh about this. Jarrad demanded a revamp of all sites. This is it.

Also, develop branch IS the staging ground which deploys to https://dev.nimbus.team/.
It's the master branch that deploys to https://nimbus.team/.

@arnetheduck
Copy link
Member

ok, so the basic things a PR like this should provide is:

  • a humane description of the work done, ie background, what changes where done (was it just style? content? rendering engine? what is it?)
  • a testing plan, ie how to go from PR to Q/A & review (this PR cannot meaningfully be reviewed in its current shape, its substance needs a different review format than diff)
  • a deployment plan, ie how to go from staging to production, who owns this and what the acceptance criteria are
  • a rollback plan, ie how and why to roll back, and who is responsible for this
  • a maintenance plan, ie who will own the technical solution going forwards - the current site engine was chosen because the current maintainers were comfortable enough dealing with problems that might ensue - who will deal with problems down the line when things break? are there resources to cover this? docosaurus is something of an arbitrary choice here, ie a few months back it was mkdocs and now it's docosaurus - what will it be next week and who will do the work of converting back and forth?

typically, the above points would have been presented / thought about prior to beginning actual work, in the form of issues open in this repo or some other commonly accepted forum where people affected by the changes hang out - maybe this has happened, in which case it should be linked to in the PR so that we have a trail to follow in future upgrades to the site.

@amirhouieh
Copy link
Contributor

@jakubgs thanks for the instructions, definitely helpful and will surely follow for further and upcoming projects.

However as for this particular project at this point of time, to be honest the request came to us as a urgency and within a super short notice with insanely short deadline. This of course effected our standard development pipeline as well as mis-alignments and miscommunications. Particularly in this case me and the team were under impression that all required communications will be handled by other folks in comms hub which apparently didn't happen.

Anyhow as said, lesson learned and lets catch up on this when storm is over. We surely can benefit from a well establish routine between infra team and our development team.

Copy link
Contributor

@kdeme kdeme left a comment

Choose a reason for hiding this comment

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

Had a quick search on anything mentioning "Portal" in the changes. Not planning on reviewing the whole thing as is.

about/roadmap.md Outdated

- Enhancing the light client, Nimbus Portal.

[Contribute to Waku](https://github.com/status-im/nimbus-eth2)
Copy link
Contributor

Choose a reason for hiding this comment

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

Wrong name for the link (Waku).


An absence of true light clients presents a major issue in today's web3 sector and contributes toward various centralizing tendencies on Ethereum. When users cannot validate on-chain data themselves—due to the technical or resource overheads of running their own validating node—they fall back on RPC nodes operated by centralized entities.

While convenient, this approach requires users to trust the data returned and represents a pale imitation of the true revolutionary promise of blockchain technology.
Copy link
Contributor

Choose a reason for hiding this comment

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

Trust is only 1 part of the story. The other is, as you mentioned above, that they are centralized entities and thus muc more susceptible to take downs (and perhaps DoS attacks). Portal is about trust + fully decentralized (no server - client model).


Nimbus Portal—our light client implementation—is among a few promising efforts to develop an Ethereum light client. Its development is part of a cross-team Ethereum Foundation initiative called Portal Network that seeks to realize the light client vision.

Alongside Nimbus Portal, Nimbus has developed a Light Web Proxy that can run in the background of applications, providing on-chain data directly to wallet apps and Ethereum-native operating systems, among other use cases.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is currently called the Nimbus Verified Proxy: https://github.com/status-im/nimbus-eth1/tree/master/nimbus_verified_proxy

This type of light clients solves (somewhat) the trust part, however not yet the centralized part.

- **Flexible:** Nimbus consensus client is the only Ethereum client that offers the flexibility of running beacon node and validator clients independently, as operators often require. Additionally, it offers a simpler beacon node mode in which the beacon node assumes validator responsibilities, mitigating the need for operators to manage the two separately.

- **Convenient:** Nimbus will be among the first client teams to offer both a consensus and execution client, simplifying initial installation and making it easy for operators to receive tailored support.

Copy link
Contributor

Choose a reason for hiding this comment

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

Might also want to mentioned something about the consensus light client that we have (and spearheaded)?

@jakubgs
Copy link
Member

jakubgs commented May 6, 2024

Should this be closed since the other PR was merged?

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

10 participants