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.

Sign up for GitHub

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

chore: fix dead links in README and site #651

Merged
merged 1 commit into from
Nov 22, 2024
Merged

chore: fix dead links in README and site #651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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/
4 changes: 2 additions & 2 deletions site/content/docs/getting-started/first-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.