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

Add cardano audit script to builder tools #1324

Merged
merged 7 commits into from
Oct 15, 2024

Conversation

Kirael12
Copy link
Contributor

👋 Hello there! Welcome. Please follow the steps below to tell us about your contribution.

  1. Please complete a Checklist
  2. Fill in all sections of the template
  3. Click "Create pull request"

Checklist

<-- Please fill the boxes with [x] before submitting a pull request -->

Builder Tool addition

<-- Provide information for every bullet in the list below. The tags you select must match the tags in your changes to the builder-tools.js -->

  • Title: Cardano Audit Script for SPOs
  • Description: A security and compliance audit script for Cardano stakepool nodes, to help SPOs check their node and security configuration.
  • Website: https://github.com/Kirael12/cardano-node-audit
  • Getstarted: null
  • Tags:
    • cli
    • operatortool

@rphair rphair added the documentation Improvements or additions to documentation label Sep 21, 2024
Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

thanks @Kirael12 - I would also recommend adding a getstarted: page under the Operate a Stake Pool > Deployment Scenarios section ... could be a paraphrase of your introduction here: https://forum.cardano.org/t/new-cardano-node-security-compliance-audit-script-for-spos-all-setup/136189

@Kirael12
Copy link
Contributor Author

hello @rphair do you mean adding a dedicated page getstarted: for the Tool, under Operate a Stake Pool > Deployment Scenarios section with a link to the tool as well ? (i though it was a bit redundant with the readme of the github).

@rphair
Copy link
Collaborator

rphair commented Sep 21, 2024

@Kirael12 I did already notice that your GitHub landing page was comprehensive and more-or-less the same as what you posted on the Cardano Forum. But still for SPOs looking for optional resources to configure their pools it would be good for it to be included with the other material you have written.

So a "stub" that talks a bit less about it (just to introduce it mainly) & links to the more detailed instructions offsite would be fine. The main thing I think is getting this tool onto that Deployment Scenarios menu.

@Kirael12
Copy link
Contributor Author

@rphair Ok, i'm going to make a new page under Stake Pool > Deployment Scenarios section. I will create another dedicated Pull Request for this

Add Deployment Scenarios -> Audit your node
Add a dedicated page for the audit-script in Deployment Scenarios section
add getstarted: for cardano-node-audit section
@Kirael12
Copy link
Contributor Author

@rphair I created a new page under Deployment -> Scenarios, and added a link to getstared:

Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

thanks @Kirael12 - just checked in a local build ✅ and it all looks & works great together. You have my double approval 😅

@rphair rphair added the builder tool Indicates a PR/issue on a builder tool label Sep 29, 2024
@rphair rphair merged commit ebcdbe2 into cardano-foundation:staging Oct 15, 2024
3 checks passed
@Kirael12
Copy link
Contributor Author

@rphair Hello :) I think there might be a problem with the merge, as the tool doesn't appear on tool page, and the new deployment scenario page seems to be missing as well

@katomm
Copy link
Member

katomm commented Oct 17, 2024

"Merged" here means into staging-branch. It is reflected here: https://staging-dev-portal.netlify.app/docs/operate-a-stake-pool/audit-your-node

@Kirael12
Copy link
Contributor Author

@katomm My bad !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
builder tool Indicates a PR/issue on a builder tool documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants