nautilus-cyberneering / secure-git-guide

A collections of articles about Git, GitHub and GPG focused on security.
https://secure-git.guide
7 stars 5 forks source link

Articles sequence is the live site is wrong #81

Open josecelano opened 7 months ago

josecelano commented 7 months ago

See https://secure-git.guide/#articles

static/
├── docs
│   ├── 001_GPG-What-is-GPG.md
│   ├── 002_GPG-Why-we-use-GPG.md
│   ├── 003-GPG-101-How-to-get-your-first-GPG-Keys.md
│   ├── 004_GPG-How-to-use-GPG-with-GIT-and-GitHub.md
│   ├── 005_GPG-Best-Practices.md
│   ├── 006_GPG-Other-Uses.md
│   ├── 007_Curated-List-of-Resources.md
│   ├── 008_GPG-How-to-create-a-subkey-for-signing.md
│   ├── 009_GPG-How-to-use-a-signing-key-independently-from-primary-key.md
│   ├── 010_GPG-Git-commits-partially-verified.md
│   ├── 011_How-to-remove-commits-by-commit-message.md
│   ├── 012_How-to-import-the-dependabot-gpg-public-key.md
│   ├── 013_How-github-actions-can-get-access-to-secrets.md
│   ├── 014_Sharing-GitHub-secrets-with-third-party-actions.md
│   ├── 015_How-to-use-Git-as-a-database.md

image

cc @da2ce7 @grmbyrn should we remove the number prefix?

I think we should include an article slug and put meta info in the markdown file like in the Torrust website (for example https://raw.githubusercontent.com/torrust/torrust-website/develop/src/routes/(blog-article)/containerizing-rust-applications-best-practices/%2Bpage.md).

echoix commented 7 months ago

We observed that an existing link to https://secure-git.guide/014_Sharing-GitHub-secrets-with-third-party-actions/ is now 404. It was referred to in our docs, and we verify our links with lychee linter. The link became https://secure-git.guide/013_Sharing-GitHub-secrets-with-third-party-actions, but we cannot assume all the internet would change the links they point to.

https://github.com/oxsecurity/megalinter/pull/3172 https://github.com/oxsecurity/megalinter/actions/runs/7052989650/job/19199178930#step:4:1018 https://github.com/oxsecurity/megalinter/actions/runs/7072922624/job/19260950110?pr=3172#step:4:1906

grmbyrn commented 7 months ago

See https://secure-git.guide/#articles

  • Articles markdown number prefixes do not match the number in the HTML list.
  • There are some missing articles.
  • The markdown file name does not match the article title.

cc @da2ce7 @grmbyrn should we remove the number prefix?

I think we should include an article slug and put meta info in the markdown file like in the Torrust website (for example https://raw.githubusercontent.com/torrust/torrust-website/develop/src/routes/(blog-article)/containerizing-rust-applications-best-practices/%2Bpage.md).

I think the problem comes from the Curated List of Resources post. It was number 7 but it had been removed the posts displayed on the website. I put it in at the bottom. I think it could be a good idea to follow something like the Torrust website and would be open to implementing it if that's what you would like to do.

echoix commented 7 months ago

In all cases, to not break all the links to your articles online, you might need to keep the old URLs, or at least redirect them to your new structure ;)

da2ce7 commented 7 months ago

We should use permanent redirects for the old URI's.