www.packageurl.org

Overview

This is the repository for the Package-URL public website. It is based on Docusaurus. This website is currently in an Alpha phase with the primary focus on content over format.

We value contributions from members of the community. You can always suggest a new feature or a change to some existing element of the website by opening an issue and, if you're ready, a PR.

• The normal process for suggesting changes is to create an issue to explain the change before creating a pull request.
• If you do submit a pull request (PR):
  • Do not use CoPilot or other AI tools to create the PR or its content. We do not accept AI-generated PRs and dealing with them takes away valuable time from our core work. The use of AI tools for research is fine, but a PR must be created and submitted by a person.
  • Do not include changes to the current project configuration - e.g., do not include an updated package-lock.json or yarn.lock with a PR.
  • Do not add new dependencies with your PR.
• It is OK to submit a PR without an issue to fix typos and other minor corrections. Please explain the changes in the PR.

The current "production" version of the website is at: https://www.packageurl.org/ .

The "staging" version of the website is at: https://package-url.github.io/www.packageurl.org/ .

Simplified website structure

The website structure necessarily follows a Docusaurus template and configuration. There are two primary ways to update the website:

• Many elements of the website -- including the navbar, the footer, the sidebars, the home/anding page -- are complex to update.
  • For these website elements you should create an issue and the core team will create the PR or help you create one.
• Most of the primary website content is composed of markdown files which are much easier to update. For these pages you will see an "Edit this page" link at the bottom of the text. You can use this link to go directly to the corresponding markdown file.
  • If the markdown page is part of the PURL or VERS specification, the markdown file will be located in the corresponding specification repository - package-url/purl-spec/docs or package-url/vers-spec/docs.
    • The .md type documentation pages linked to the cards in the Registered PURL Types grid are auto-generated from the PURL JSON Schema *-definition.json files located in the purl-spec repo. These .md files can be modified only by editing the underlying .json files.
  • Otherwise the markdown page will be located at package-url/www.packageurl.org/website/docs

You can use the GitHub UI to create a new branch and PR or you can create a branch and PR locally in your preferred GitHub tools.