Skip to content

Comments

Gitbook - Top 10 2021#527

Merged
vanderaj merged 4 commits intomasterfrom
2021-gitbook
Sep 8, 2021
Merged

Gitbook - Top 10 2021#527
vanderaj merged 4 commits intomasterfrom
2021-gitbook

Conversation

@vanderaj
Copy link
Member

No description provided.

@jmanico
Copy link
Member

jmanico commented Aug 27, 2021

How exciting you are using this! :)

@mackowski
Copy link

@Naramsim this PR is for reusing GT Actions from cheatsheet project to build OWASP top 10 webpage. Do you want to take part in this?

@Naramsim
Copy link
Contributor

Naramsim commented Sep 1, 2021

Sure, where can I help?

@mackowski
Copy link

@vanderaj want to reuse build process from cheatsheets to generate webpage for top 10. But it does a lot more than they need. For top 10 just a simple to view OWASP Top 10 list on the left hand side, A00 - A11 is needed https://github.com/OWASP/Top10/tree/master/2021/en.
They does not need indexes, spellcheck, linting, RSS feed etc.

@Naramsim
Copy link
Contributor

Naramsim commented Sep 1, 2021

Hello @vanderaj @mackowski,

from what I understood you wanna create a website for showing the new Top10. Ideally, this website should be built with MkDocs and fully deployed with Github.

So here is my take: We start from scratch and do not use the files (which are super messy) of the Cheatsheet repo. We create a website that supports i18n and we build a pipeline for deploying it. Nice and clean.

I opened #528 to show you how could we build the website. The important part is that i18n is supported, as I see in the past years you had numerous translations. This is the mkdocs.yml file and it looks super clean. Translated pages are organized by extension (file_name.fr.md) and not by folder.

I suggest you try out and see by yourself the outcome of my PR, you can follow the instructions on the PR for spinning up a local version. The site supports 3 languages and some pages are translate. Pages that miss a translation are displayed in the default language (en).

Let me know if you like my approach, and if so, we can start building and deploying the website together.

@Naramsim
Copy link
Contributor

Naramsim commented Sep 1, 2021

top10fr

Here is a screenshot of my PR. You can see the A01 vulnerability in French. Vulnerabilities from A02 to A10 weren't translated, thus they show the English text on the left side.

@mackowski
Copy link

@Naramsim I like it. Thank you!
@vanderaj what do you think about it?

@mackowski
Copy link

@vanderaj what do you think about it?

@vanderaj
Copy link
Member Author

vanderaj commented Sep 8, 2021 via email

* feat: add skeleton

* Moved into the right folder

This builds and looks good.

Co-authored-by: Andrew van der Stock <vanderaj@owasp.org>
@vanderaj vanderaj closed this Sep 8, 2021
@vanderaj
Copy link
Member Author

vanderaj commented Sep 8, 2021

Argh

@vanderaj vanderaj reopened this Sep 8, 2021
@vanderaj vanderaj merged commit b39c782 into master Sep 8, 2021
@vanderaj vanderaj deleted the 2021-gitbook branch September 8, 2021 19:57
@Naramsim
Copy link
Contributor

Naramsim commented Sep 9, 2021

Hi everyone,

I'll try to work on the website these days. At some point we will need the top10 translated in the various languages, are those documents available?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants