diff --git a/docs/content/contributing/CONTRIBUTINGKS.md b/docs/content/contributing/CONTRIBUTINGKS.md index 4fb721a508..9832b7d8e0 100644 --- a/docs/content/contributing/CONTRIBUTINGKS.md +++ b/docs/content/contributing/CONTRIBUTINGKS.md @@ -94,7 +94,7 @@ Following are a few more things to keep in mind when making a pull request. - Learn to use `git rebase`. It is your friend. It is one of your most helpful friends. It is how you can cope when other changes merge while you are in the midst of working on your PR. - There are, broadly speaking, two styles of using Git history: keeping an accurate record of your development process, or producing a simple explanation of the end result. We aim for the latter. Squash out uninteresting intermediate commits. - Do not merge from `main` into your PR's branch. That makes a tangled Git history, and we prefer to keep it simple. Instead, rebase your PR's branch onto the latest edition of `main`. -- When adding/updating a GitHub Actions workflow, be aware of the [action reference discipline](#github-action-reference-discipline). +- When adding/updating a GitHub Actions workflow, follow the action reference discipline. - For a PR that modifies the website, include a preview. That gets much easier if you follow the documentation about setting up for that (i.e., properly create your `gh-pages` branch, enabling its use in your fork's settings) and make the name of your PR's branch start with "doc-". If you already have a PR with a different sort of name, you can explicitly invoke the rendering workflow --- unless your branch name has a slash or other exotic character in it; stick to alphanumerics plus dash and dot. You cannot change the name of the branch in a PR, but you can close a PR and open an equivalent one using a branch with a good name. - For a PR that modifies the website, remember that the doc source files are viewed two ways (see the website documentation); make them work in both views. - If you mix pervasive changes to whitespace with substantial changes, you risk GitHub's display of the diff becoming confused. DO check that. If the diff display is confused, it makes reviewing much harder. Have mercy on your reviewers; skip the pervasive whitespace changes if they confuse GitHub's diff. BTW, did you really intend to make all those whitespace changes, or are they an unintended gift from your IDE? Don't make changes that you do not really intend. diff --git a/docs/content/contributing/contributor_ladder.md b/docs/content/contributing/contributor_ladder.md index 6e5520fae9..1f5670c71c 100644 --- a/docs/content/contributing/contributor_ladder.md +++ b/docs/content/contributing/contributor_ladder.md @@ -96,7 +96,7 @@ Promotion to paid intern requires completion of the above plus: - CI trigger permissions - Access to private maintainer channels or security advisories -**Returning from Emeritus:** +#### Returning from Emeritus Emeritus members have a streamlined path back — they do not start from scratch: diff --git a/docs/content/multi-plugin/api_reference.md b/docs/content/multi-plugin/api_reference.md index c6752570fe..3a7d338385 100644 --- a/docs/content/multi-plugin/api_reference.md +++ b/docs/content/multi-plugin/api_reference.md @@ -435,4 +435,4 @@ func buildHeader(resourceType string, allNamespaces, showLabels bool) string { } ``` -This API reference provides a comprehensive overview of the kubectl-multi codebase. For usage examples, see the [Usage Guide](usage_guide), and for architectural details, see the [Architecture Guide](architecture_guide). +This API reference provides a comprehensive overview of the kubectl-multi codebase. For usage examples, see the [Usage Guide](usage_guide.md), and for architectural details, see the [Architecture Guide](architecture_guide.md). diff --git a/docs/content/multi-plugin/getting-started.md b/docs/content/multi-plugin/getting-started.md index c713e65593..3023b4d341 100644 --- a/docs/content/multi-plugin/getting-started.md +++ b/docs/content/multi-plugin/getting-started.md @@ -27,11 +27,11 @@ kubectl multi get pods -A ## Documentation -- **[Installation Guide](installation_guide)** - How to install and set up kubectl-multi -- **[Usage Guide](usage_guide)** - Detailed usage examples and commands -- **[Architecture Guide](architecture_guide)** - Technical architecture and how it works -- **[Development Guide](development_guide)** - Contributing and development workflow -- **[API Reference](api_reference)** - Code organization and technical implementation +- **[Installation Guide](installation_guide.md)** - How to install and set up kubectl-multi +- **[Usage Guide](usage_guide.md)** - Detailed usage examples and commands +- **[Architecture Guide](architecture_guide.md)** - Technical architecture and how it works +- **[Development Guide](development_guide.md)** - Contributing and development workflow +- **[API Reference](api_reference.md)** - Code organization and technical implementation ## Tech Stack diff --git a/docs/content/multi-plugin/installation_guide.md b/docs/content/multi-plugin/installation_guide.md index 93424b0f6d..4b987f1e93 100644 --- a/docs/content/multi-plugin/installation_guide.md +++ b/docs/content/multi-plugin/installation_guide.md @@ -202,6 +202,6 @@ make uninstall ## Next Steps After successful installation: -1. Read the [Usage Guide](usage_guide) for detailed examples -2. Check the [Architecture Guide](architecture_guide) to understand how it works -3. See [Development Guide](development_guide) if you want to contribute +1. Read the [Usage Guide](usage_guide.md) for detailed examples +2. Check the [Architecture Guide](architecture_guide.md) to understand how it works +3. See [Development Guide](development_guide.md) if you want to contribute diff --git a/docs/content/multi-plugin/overview.md b/docs/content/multi-plugin/overview.md index dde5296913..d694847221 100644 --- a/docs/content/multi-plugin/overview.md +++ b/docs/content/multi-plugin/overview.md @@ -79,11 +79,11 @@ kubectl multi get pods -A Complete documentation for kubectl-multi: -- **[Installation Guide](installation_guide)** - How to install and set up kubectl-multi -- **[Usage Guide](usage_guide)** - Detailed usage examples and commands -- **[Architecture Guide](architecture_guide)** - Technical architecture and how it works -- **[Development Guide](development_guide)** - Contributing and development workflow -- **[API Reference](api_reference)** - Code organization and technical implementation +- **[Installation Guide](installation_guide.md)** - How to install and set up kubectl-multi +- **[Usage Guide](usage_guide.md)** - Detailed usage examples and commands +- **[Architecture Guide](architecture_guide.md)** - Technical architecture and how it works +- **[Development Guide](development_guide.md)** - Contributing and development workflow +- **[API Reference](api_reference.md)** - Code organization and technical implementation ## Tech Stack diff --git a/docs/content/multi-plugin/overview/introduction.md b/docs/content/multi-plugin/overview/introduction.md index 47936d6815..b2e292387b 100644 --- a/docs/content/multi-plugin/overview/introduction.md +++ b/docs/content/multi-plugin/overview/introduction.md @@ -27,11 +27,11 @@ kubectl multi get pods -A ## Documentation -- **[Installation Guide](/docs/multi-plugin/installation_guide)** - How to install and set up kubectl-multi -- **[Usage Guide](/docs/multi-plugin/usage_guide)** - Detailed usage examples and commands -- **[Architecture Guide](/docs/multi-plugin/architecture_guide)** - Technical architecture and how it works -- **[Development Guide](/docs/multi-plugin/development_guide)** - Contributing and development workflow -- **[API Reference](/docs/multi-plugin/api_reference)** - Code organization and technical implementation +- **[Installation Guide](../installation_guide.md)** - How to install and set up kubectl-multi +- **[Usage Guide](../usage_guide.md)** - Detailed usage examples and commands +- **[Architecture Guide](../architecture_guide.md)** - Technical architecture and how it works +- **[Development Guide](../development_guide.md)** - Contributing and development workflow +- **[API Reference](../api_reference.md)** - Code organization and technical implementation ## Tech Stack diff --git a/docs/content/multi-plugin/readme.md b/docs/content/multi-plugin/readme.md index 9f8c36e5a0..0324a5ed9d 100644 --- a/docs/content/multi-plugin/readme.md +++ b/docs/content/multi-plugin/readme.md @@ -77,11 +77,11 @@ kubectl multi get pods -A ## Documentation -- **[Installation Guide](installation_guide)** - How to install and set up kubectl-multi -- **[Usage Guide](usage_guide)** - Detailed usage examples and commands -- **[Architecture Guide](architecture_guide)** - Technical architecture and how it works -- **[Development Guide](development_guide)** - Contributing and development workflow -- **[API Reference](api_reference)** - Code organization and technical implementation +- **[Installation Guide](installation_guide.md)** - How to install and set up kubectl-multi +- **[Usage Guide](usage_guide.md)** - Detailed usage examples and commands +- **[Architecture Guide](architecture_guide.md)** - Technical architecture and how it works +- **[Development Guide](development_guide.md)** - Contributing and development workflow +- **[API Reference](api_reference.md)** - Code organization and technical implementation ## Tech Stack diff --git a/docs/content/multi-plugin/reference.md b/docs/content/multi-plugin/reference.md index c6752570fe..3a7d338385 100644 --- a/docs/content/multi-plugin/reference.md +++ b/docs/content/multi-plugin/reference.md @@ -435,4 +435,4 @@ func buildHeader(resourceType string, allNamespaces, showLabels bool) string { } ``` -This API reference provides a comprehensive overview of the kubectl-multi codebase. For usage examples, see the [Usage Guide](usage_guide), and for architectural details, see the [Architecture Guide](architecture_guide). +This API reference provides a comprehensive overview of the kubectl-multi codebase. For usage examples, see the [Usage Guide](usage_guide.md), and for architectural details, see the [Architecture Guide](architecture_guide.md). diff --git a/docs/content/multi-plugin/usage_guide.md b/docs/content/multi-plugin/usage_guide.md index 03b0c1a2ae..77684c0c70 100644 --- a/docs/content/multi-plugin/usage_guide.md +++ b/docs/content/multi-plugin/usage_guide.md @@ -288,6 +288,6 @@ kubectl multi get --help ## Next Steps -- Learn about the internal [Architecture](architecture_guide) -- Contribute to development with the [Development Guide](development_guide) -- Check the [API Reference](api_reference) for technical details +- Learn about the internal [Architecture](architecture_guide.md) +- Contribute to development with the [Development Guide](development_guide.md) +- Check the [API Reference](api_reference.md) for technical details diff --git a/runbooks/scorecard-monitoring.md b/runbooks/scorecard-monitoring.md index 18e2d5b713..2b27959933 100644 --- a/runbooks/scorecard-monitoring.md +++ b/runbooks/scorecard-monitoring.md @@ -54,8 +54,8 @@ missed or you want to confirm independently: and confirm a run exists for the most recent Monday. A missing run, or one that ended with a red X, means the weekly scan did not complete. 2. Check the repository's - [Security > Code scanning alerts](https://github.com/kubestellar/docs/security/code-scanning) - tab for a recent Scorecard entry. If the most recent Scorecard alert + [Security tab](https://github.com/kubestellar/docs/security) + for a recent Scorecard entry. If the most recent Scorecard alert batch is more than ~8 days old, the weekly upload likely did not succeed. 3. If either check indicates a stalled/failed run, check the failed job's