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 sections overhaul #441

Merged
merged 23 commits into from
Nov 27, 2024
Merged

Docs sections overhaul #441

merged 23 commits into from
Nov 27, 2024

Conversation

slugmann321
Copy link
Contributor

Restructuring the docs sections in line with the plan as per the Notion page
https://www.notion.so/obol-dvt/Add-super-categories-115a7b296f45800cb201fc456109dbfe

Copy link

netlify bot commented Oct 28, 2024

Deploy Preview for obol-docs ready!

Name Link
🔨 Latest commit d8aa055
🔍 Latest deploy log https://app.netlify.com/sites/obol-docs/deploys/67461ea99f18100008a1b227
😎 Deploy Preview https://deploy-preview-441--obol-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@KaloyanTanev KaloyanTanev left a comment

Choose a reason for hiding this comment

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

I have not checked the links. We can play around with this version before merging once the pipelines are fixed (they make a temp deployment visible by everyone).

docs/adv/security/bug-bounty.md Show resolved Hide resolved
docs/guides/walkthroughs/walkthrough-guides.md Outdated Show resolved Hide resolved
sidebar_position: 5
description: Claiming rewards from your DV using the Launchpad.
---
# Claiming DV rewards
Copy link
Contributor

Choose a reason for hiding this comment

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

Something went wrong here I think? This page is not related to claiming rewards, but a copy of monitoring.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will be a brand new page that we need to write. I went ahead and created it so at least it exists, so then we can fill it in later. There are many such pages that need creation or overhauling once this PR is complete...

Copy link
Contributor

Choose a reason for hiding this comment

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

Can we delete the monitoring part below then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ah, yes, didn't realize that. Must have been a mistake

Copy link
Contributor

Choose a reason for hiding this comment

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

There are many such pages that need creation or overhauling once this PR is complete...

Define complete. Should I be expecting them to be complete before we merge this PR as complete? Or are we taking them out and merging in a dedicated PR when ready?

Copy link
Contributor Author

@slugmann321 slugmann321 Nov 26, 2024

Choose a reason for hiding this comment

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

This PR is just the new structure. This page is just a "placeholder" page that I've created. I removed the previous copy-paste that was left in by mistake. Currently the page just reads "This page is currently just a placeholder. Content coming soon."


# Use an existing beacon node

You may have an existing beacon node and wish to use it to run as part of a DV cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this page supposed to be... only 1 sentence?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as previous comment, this will be a brand new page, instead of having this information where it is currently at the bottom of the group quickstart as a selector tab.

Copy link
Contributor

Choose a reason for hiding this comment

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

To do.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah this is another placeholder page. Need to add more content.

@slugmann321 slugmann321 force-pushed the docs_sections_overhaul branch from 86f703d to 0d4ce1e Compare November 1, 2024 12:58
@slugmann321
Copy link
Contributor Author

I added /next to all the redirects or else it didn't want to pass the test deployment check... this will need to be removed later...?

docs/learn/intro/obol-vs-others.md Outdated Show resolved Hide resolved
docs/learn/intro/obol-vs-others.md Outdated Show resolved Hide resolved
docs/learn/intro/obol-vs-others.md Outdated Show resolved Hide resolved
docs/learn/intro/obol-vs-others.md Outdated Show resolved Hide resolved
docs/learn/intro/obol-vs-others.md Outdated Show resolved Hide resolved
docs/run/integrations/lido-csm.md Outdated Show resolved Hide resolved
@HananINouman HananINouman force-pushed the docs_sections_overhaul branch from fff2e6b to 4a06043 Compare November 25, 2024 17:35
docs/guides/walkthroughs/CSM-walkthrough.md Outdated Show resolved Hide resolved
docs/guides/walkthroughs/walkthrough-guides.md Outdated Show resolved Hide resolved
docs/guides/walkthroughs/walkthrough-guides.md Outdated Show resolved Hide resolved
docs/guides/walkthroughs/walkthrough-guides.md Outdated Show resolved Hide resolved
docs/learn/futher-reading/resources.md Outdated Show resolved Hide resolved
docs/learn/intro/obol-vs-others.md Outdated Show resolved Hide resolved
docs/learn/intro/obol-vs-others.md Outdated Show resolved Hide resolved
docs/learn/intro/obol-vs-others.md Outdated Show resolved Hide resolved
docs/learn/intro/obol-vs-others.md Outdated Show resolved Hide resolved
static/img/GossipNetwork.png Outdated Show resolved Hide resolved
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
52.7% Duplication on New Code (required ≤ 30%)

See analysis details on SonarQube Cloud

@slugmann321 slugmann321 merged commit 91e53d1 into main Nov 27, 2024
5 of 6 checks passed
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.

4 participants