Skip to content
This repository has been archived by the owner on Jun 4, 2024. It is now read-only.

Add Node Security page #697

Merged
merged 3 commits into from
May 2, 2024
Merged

Add Node Security page #697

merged 3 commits into from
May 2, 2024

Conversation

blukat29
Copy link
Contributor

Proposed changes

  • Add the "Securing nodes" page under the Nodes > Core Cell guides.
  • It's about general security advice for node operators.

Note to maintainers:

  • I tried to build the docs but failed with a "Hook useDoc is called outside the " error. Therefore I am only submitting a markdown file.
  • I want to locate this page in the Core Cell section. Teach me how or configure yourself, please.
     [Nodes]
     Core Cell
     	System Requirements
     	Network Configuration
     	Install Core Cell
     	Monitor Core Cell
     	Configure High Availability
     	Securing Nodes <-- here
    

Types of changes

Please put an x in the boxes related to your change.

  • Minor Issues and Typos
  • Major Content Contribution
  • Others

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to reach out. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING GUIDELINES
  • I have signed the CLA
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Related issues

  • Please leave the issue numbers or links related to this PR here.

Further comments

If this is a relatively large content contribution, kick off the discussion by explaining why you would suggest the content contribution, etc...

@ayo-klaytn
Copy link
Contributor

ayo-klaytn commented Apr 29, 2024

Hi @blukat29
Kindly follow this guide to include the newly added content in the Nav Sidebar section of the docs

Screenshot 2024-04-29 at 23 51 39 Screenshot 2024-04-29 at 23 54 02 Screenshot 2024-04-30 at 00 06 19

Having created the securing-nodes.md file, you need to add it to the sidebar.js file for it to be properly indexed on the docs Nav Sidebar.

I hope it helps 🤝

docs/nodes/core-cell/securing-nodes.md Outdated Show resolved Hide resolved
docs/nodes/core-cell/securing-nodes.md Outdated Show resolved Hide resolved
docs/nodes/core-cell/securing-nodes.md Outdated Show resolved Hide resolved
docs/nodes/core-cell/securing-nodes.md Outdated Show resolved Hide resolved
docs/nodes/core-cell/securing-nodes.md Outdated Show resolved Hide resolved
docs/nodes/core-cell/securing-nodes.md Outdated Show resolved Hide resolved
@scott-klaytn
Copy link
Collaborator

@blukat29

I tried to build the docs but failed with a "Hook useDoc is called outside the " error. Therefore I am only submitting a markdown file.

Have you tried updating Docusaurus packages?

@blukat29
Copy link
Contributor Author

@ayo-klaytn Thank you. I'll do it.
@scott-klaytn I failed when I rm -rf node_modules and reinstalled. But I succeeded with yarn upgrade. Thanks.

@blukat29 blukat29 changed the title Add Securing nodes page Add Node Security page Apr 30, 2024
@blukat29
Copy link
Contributor Author

@ayo-klaytn Added to the sidebar. Working on my local environment. I changed the page title from "Securing nodes" to "Node Security".
@scott-klaytn Edited as per your comments.

@blukat29 blukat29 merged commit d807499 into main May 2, 2024
2 checks passed
@blukat29 blukat29 deleted the ollie/securing-nodes branch May 2, 2024 01:51
@github-actions github-actions bot locked and limited conversation to collaborators May 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants