diff --git a/changelog.d/568.doc b/changelog.d/568.doc new file mode 100644 index 00000000..7f40c35e --- /dev/null +++ b/changelog.d/568.doc @@ -0,0 +1 @@ +Improve navigability & legibility of some documentation pages. diff --git a/docs/setup/github.md b/docs/setup/github.md index 6d924d9b..22f8d764 100644 --- a/docs/setup/github.md +++ b/docs/setup/github.md @@ -89,4 +89,4 @@ are supported. If you have followed these steps correctly, GitHub should now be configured with hookshot 🥳. -You can now follow the guide on [authenticating with GitHub](../usage/auth.md), and then [bridging a room](../usage/room_configuration/github_repo.md#setting-up) +You can now follow the guide on [authenticating with GitHub](../usage/auth.md#github), and then [bridging a room](../usage/room_configuration/github_repo.md#setting-up) diff --git a/docs/setup/gitlab.md b/docs/setup/gitlab.md index e7f2c012..38300a93 100644 --- a/docs/setup/gitlab.md +++ b/docs/setup/gitlab.md @@ -35,5 +35,5 @@ if the request made it through, however. ## Adding a repository -You can now follow the guide on [authenticating with GitLab](../usage/auth.md), and then [bridging a room](../usage/room_configuration/gitlab_project.md#setting-up) +You can now follow the guide on [authenticating with GitLab](../usage/auth.md#gitlab), and then [bridging a room](../usage/room_configuration/gitlab_project.md#setting-up) diff --git a/docs/usage/auth.md b/docs/usage/auth.md index d8c87058..f8da0102 100644 --- a/docs/usage/auth.md +++ b/docs/usage/auth.md @@ -48,7 +48,7 @@ You can authenticate with GitLab by supplying a Personal Access Token. OAuth-sty yet. - You will need to have configured a GitLab instance in your config.yml for the instance you want to log in to. -- Open https://%instance%/-/profile/personal_access_tokens (GitLab > User Settings > Access Tokens), where instance is your GitLab instance address. +- Open **https://%instance%/-/profile/personal_access_tokens** (GitLab > User Settings > Access Tokens), where instance is your GitLab instance address. - For the public GitLab server, this would be "gitlab.com" - Give it a good name, and a sensible expiration date. For scopes you will need to tick `api`. - Send the generated token to the bridge by saying `gitlab personaltoken %instance% %your-token%`. You can redact