Skip to content

Maintenance Documentation#330

Open
Mouse933 wants to merge 8 commits into
Redback-Operations:mainfrom
Mouse933:maintenance_docs
Open

Maintenance Documentation#330
Mouse933 wants to merge 8 commits into
Redback-Operations:mainfrom
Mouse933:maintenance_docs

Conversation

@Mouse933
Copy link
Copy Markdown
Contributor

@Mouse933 Mouse933 commented May 2, 2026

This PR adds in a new file that shows how to fix the docusaurus instance/documentation hub when the issue that was preventing the test deployment from working is present.

Alongside this it also has the broader goal of setting up a maintenance hub for the cybersecurity team where all teams can compile maintenance and break fix documentation for our various tools. This will aid redback as a whole by reducing the time needed for future cohorts to find fixes for common issues that have been noted and logged, giving them simple easy to understand instructions they can use to get the tool or repository back to a working condition as quickly as possible.

@Mouse933 Mouse933 requested review from a team as code owners May 2, 2026 01:31
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

🔒 OWASP Scanner Results

No vulnerabilities detected.

### File: docs/cybersecurity/Maintenance Docs/Docusaurus Maintenance/Test Deployment Failing Yarn Lockfile.md

🔒 OWASP Scanner Results for docs/cybersecurity/Maintenance Docs/Docusaurus Maintenance/Test Deployment Failing Yarn Lockfile.md

✅ No vulnerabilities found.


### File: docs/cybersecurity/Maintenance Docs/Docusaurus Maintenance/_category_.json

🔒 OWASP Scanner Results for docs/cybersecurity/Maintenance Docs/Docusaurus Maintenance/_category_.json

✅ No vulnerabilities found.


### File: docs/cybersecurity/Maintenance Docs/Maintenance Introduction.md

🔒 OWASP Scanner Results for docs/cybersecurity/Maintenance Docs/Maintenance Introduction.md

✅ No vulnerabilities found.


### File: docs/cybersecurity/Maintenance Docs/_category_.json

🔒 OWASP Scanner Results for docs/cybersecurity/Maintenance Docs/_category_.json

✅ No vulnerabilities found.

✅ Good to go.

Copy link
Copy Markdown

@VishalAbiman05 VishalAbiman05 left a comment

Choose a reason for hiding this comment

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

Security review – PR #330

I've reviewed the maintenance documentation changes, including the Yarn lockfile troubleshooting guide and the introduction.

What I checked:

  • No hardcoded credentials, API keys, tokens, or internal IP addresses
  • No real secrets or sensitive infrastructure details exposed
  • Commands are standard for Yarn and Docusaurus maintenance
  • External links to GitHub and Yarn documentation use HTTPS

Security observations and suggestions:

  1. sudo usage – In a prior screenshot I saw a command like sudo /home/bin/act. If users are instructed to use sudo with act, please add a warning:

    "Running commands with sudo grants elevated privileges. Only do this if you trust the script and understand the risks."

  2. yarn install without --frozen-lockfile – Step 4 instructs users to run yarn install (without the flag) to regenerate the lockfile. This is fine, but consider adding a note:

    "After regenerating, always verify that only expected dependencies changed. Review the diff before committing."

  3. Running act locally – The optional step using act executes CI workflows that could modify files or access secrets (though it's expected to fail). Recommend adding:

    "Before running act, ensure you are in a clean directory and have no sensitive environment variables set. The tool may attempt to emulate GitHub Actions behaviour."

Overall assessment:
The documentation is well-written and addresses a real maintenance issue. No blocking security problems. Good to merge after considering the minor security warnings above.

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.

2 participants