From 1f789d95e2e1972596face4d0b54d118e3d51a50 Mon Sep 17 00:00:00 2001 From: Stefan Schmidt Date: Wed, 21 Feb 2024 18:07:18 +0100 Subject: [PATCH] Fixing the links getting-started and how-to-use (#452) * fix use-case links getting-started.md * fix the use-case links fix getting-started.md * fix links how-to-use.md * fix links how-to-use.md --- docs/getting-started.md | 6 +++--- docs/how-to-use/how-to-use.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 3659c53c..601fe6a8 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -24,9 +24,9 @@ Talisman is a tool to help you prevent or detect potential secrets from getting It supports MAC OSX, Linux and Windows 10. Follow the quick links below based on your use-case: -1. [Install Talisman](#installation) -2. [Use Talisman as a pre-commit/pre-push hook](#as-a-hook) -3. [Use Talisman as a repository scanner](#as-a-git-scanner) +1. [Install Talisman](installation/installation.md) +2. [Use Talisman as a pre-commit/pre-push hook](how-to-use/as-a-hook.md) +3. [Use Talisman as a repository scanner](how-to-use/as-a-git-scanner.md) You can also follow the links given in the menu options for a more detailed navigation. diff --git a/docs/how-to-use/how-to-use.md b/docs/how-to-use/how-to-use.md index 0fccc574..7c417210 100644 --- a/docs/how-to-use/how-to-use.md +++ b/docs/how-to-use/how-to-use.md @@ -13,9 +13,9 @@ permalink: docs/how-to-use Talisman acts as as a hook (pre-commit or pre-push) to your git repository on the developer's machine itself.
However, you can't always guarantee that all checkins made to the git repository came through a similar validation. Which is why you might also want to run Talisman to scan your complete git history.
Here are the different ways you can use Talisman: -1. [Talisman as a hook](./as-a-hook) : Sits on a developer's machine to ensure secrets do not get checked-in -2. [Talisman as a git scanner](./as-a-git-scanner) : Run against the complete git history to find if secrets got leaked or checked in your repository -3. [Other utilities](./as-a-utility) : Find more utilities as a CLI to calculate checksum, debug etc. +1. [Talisman as a hook](./as-a-hook.md) : Sits on a developer's machine to ensure secrets do not get checked-in +2. [Talisman as a git scanner](./as-a-git-scanner.md) : Run against the complete git history to find if secrets got leaked or checked in your repository +3. [Talisman as a cli utility](./as-a-utility.md) : Find more utilities as a CLI to calculate checksum, debug etc.
You will be able to find more details about [how to configure](docs/configuring-talisman)