OWASP / OWASP/ASVS

[Proposal] Automatically generate GH page

Open
#895 7 comments 1 reaction 1 assignee View on GitHub

@elarlang is already working on this.

Since Mar 16, 2024.

_5.0 - Not blocker Community wanted
Dominant language
HTML
Stars
3.6k
Forks
831
Avg merge
7h 55m
Merged PRs (30d)
4

Description

While GitHub automatically renders the PDF stored in the repo under the corresponding version directory. It would be nice to have a linked GitHub page that automatically loads and renders from the available markdown.
This would decrease the friction of trying to find/read/reference a specific section without downloading files or scrolling forever through a pdf in a subdirectory.

Though I suppose if this were to be done, it would be preferable to render it to page for the OWASP site like is done for the WSTG.

The simplest option might just be to have a static HTML file that uses docsify to dynamically load all the markdown.
Or if indexability and speed are worth the additional complexity, a github action could be set up to statically generate the page with its content.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.