From 34fc6d8edba48a13177858b2da8d1dca57b6f5b9 Mon Sep 17 00:00:00 2001 From: Andrew Lilley Brinker Date: Fri, 22 Nov 2024 10:13:47 -0800 Subject: [PATCH] chore: fix dead links in README and site Signed-off-by: Andrew Lilley Brinker --- README.md | 11 ++++------- site/content/docs/getting-started/first-run.md | 4 ++-- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7b99df1b..250e8474 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![GitHub Release](https://img.shields.io/github/v/release/mitre/hipcheck)][release] [![Hipcheck Website](https://img.shields.io/badge/Website-blue)][website] -__Go from hundreds of dependencies you can't review, to just a few you can!__ +_Helping maintainers assess software packages for long term risk._ Managing the security risk of third-party software at scale is difficult. Normal projects can easily have hundreds of dependencies; far too many to @@ -20,8 +20,6 @@ chain risk. It analyzes a project's _software development practices_ and detects _active supply chain attacks_ to give you both a long-term and immediate picture of the risk from using a package. -For more information, see ["Why Hipcheck?"][why] - ## Very Quick Explanation Hipcheck can analyze Git source repositories and open source packages from @@ -74,10 +72,9 @@ found in the [`LICENSE`](LICENSE) file in this repository. > (FEB 2014)][dfars]. [dfars]: https://www.acquisition.gov/dfars/252.227-7014-rights-other-commercial-computer-software-and-other-commercial-computer-software-documentation. -[quickstart]: https://mitre.github.io/hipcheck/docs/quickstart/ -[install]: https://mitre.github.io/hipcheck/install +[quickstart]: https://mitre.github.io/hipcheck/docs/getting-started/first-run/ +[install]: https://mitre.github.io/hipcheck/docs/getting-started/install/ [license]: https://github.com/mitre/hipcheck/blob/main/LICENSE [release]: https://github.com/mitre/hipcheck/releases/latest -[rfd_2]: https://mitre.github.io/hipcheck/rfds/0002 +[rfd_2]: https://mitre.github.io/hipcheck/docs/rfds/0002/ [website]: https://mitre.github.io/hipcheck -[why]: https://mitre.github.io/hipcheck/docs/guide/why/ diff --git a/site/content/docs/getting-started/first-run.md b/site/content/docs/getting-started/first-run.md index 67a56c06..3e551f14 100644 --- a/site/content/docs/getting-started/first-run.md +++ b/site/content/docs/getting-started/first-run.md @@ -272,7 +272,7 @@ interested in their results. You can also change how specific analyses work, and configure your risk tolerance to your liking as well. In general, Hipcheck is designed to adapt to your own policies and risk considerations, not the other way around. More about this is covered in the Hipcheck -[Complete Guide](/docs/guide). +[Complete Guide](@/docs/guide/_index.md). In this case, Hipcheck has given itself a `PASS` (would be concerning if it didn't)! This means that, by Hipcheck's estimation, you should feel comfortable @@ -283,7 +283,7 @@ using it without further manual investigation. With that, we've completed the Quickstart guide to Hipcheck! If you'd like to understand more about Hipcheck's underlying concepts, how it works under the hood, how to configure it, how to interpret the results, and more, we recommend -reading the [Complete Guide](/docs/guide). +reading the [Complete Guide](@/docs/guide/_index.md). If you have questions about using Hipcheck, feel free to ask them on our [Discussions](https://github.com/mitre/hipcheck/discussions) forum.