Skip to content

Commit

Permalink
impl: add convenience /gh redirect to our GitHub repo (#893)
Browse files Browse the repository at this point in the history
Now `https://slsa.dev/gh[/...]` is an easier-to-type alias for
`https://github.com/slsa-framework/slsa[/...]`.

This is the first PR that sets up Netlify redirects. Future PRs will
update our existing redirects to use this new framework.

Can be tested through deploy previews or through the Netlify CLI.
(Future PR will update our dev documentation.)

Signed-off-by: Mark Lodato <[email protected]>
  • Loading branch information
MarkLodato authored Jul 1, 2023
1 parent 5e7d274 commit a17d5c7
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,6 @@ node_modules
# Ignore the following files markdownlint that are already tracked by git (thus
# uanffected by gitignore).
/LICENSE.md

# Local Netlify folder
.netlify
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,22 @@ specification, and overall project management. Other git repositories within the
[slsa-framework](https://github.com/slsa-framework) organization have
repo-specific issue trackers.

## URL Aliases

We have several [redirect](docs/_redirects) configured on slsa.dev for
convenience of the team:

- https://slsa.dev/gh &rArr; SLSA GitHub repo
- https://slsa.dev/gh/issues
- https://slsa.dev/gh/pulls
- etc...
- https://slsa.dev/notes &rArr; meeting notes
- https://slsa.dev/notes/community
- https://slsa.dev/notes/positioning
- https://slsa.dev/notes/specification
(or [.../spec](https://slsa.dev/notes/spec))
- https://slsa.dev/notes/tooling

## How to get involved

See https://slsa.dev/community for ways to get involved in SLSA development.
Expand Down
2 changes: 2 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ collections:
layout: post
output: true
permalink: /blog/:year/:month/:title
include:
- _redirects
exclude:
- CNAME
- Gemfile
Expand Down
4 changes: 4 additions & 0 deletions docs/_redirects
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Documentation: https://docs.netlify.com/routing/redirects/redirect-options/

# Convenience aliases for the team. Remember to document on ../README.md.
/gh/* https://github.com/slsa-framework/slsa/:splat

0 comments on commit a17d5c7

Please sign in to comment.