Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/archive/gsoc/org_pages/gsoc_2017.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Google Summer of Code 2017
==========================


.. image:: https://cdn.rawgit.com/wiki/nexB/aboutcode/aboutcode_logo.svg
.. image:: https://raw.githubusercontent.com/wiki/aboutcode-org/aboutcode/aboutcode_logo.svg
:target: http://www.aboutcode.org/
:alt: AboutCode Logo

Expand Down
1 change: 1 addition & 0 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ Contribution Guidelines:
contributing/writing_good_commit_messages
contributing/testing
contributing/contrib_doc
contributing/release_news
4 changes: 3 additions & 1 deletion docs/source/contributing/contrib_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@ following commands are examples::
git add source/index.rst
git add source/how-to-scan.rst
git status
git commit -m "New how-to document that explains how to scan"
# Prefer full issue URLs for cross-repo clarity. Use shorthand #123 only
# if the change will stay in the same repository.
git commit -m "New how-to document that explains how to scan https://github.com/aboutcode-org/aboutcode/issues/106"
git status
git push
git status
Expand Down
85 changes: 85 additions & 0 deletions docs/source/contributing/release_news.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
########################################
Publishing release news to aboutcode.org
########################################

Goal
====
Provide a repeatable way for any AboutCode project to publish a release
announcement to the AboutCode news feed with minimal manual steps.

Generate a post locally
=======================

Use the helper script in this repo to create a news file in
``docs/source/news/posts``:

.. code-block:: bash

python tools/generate_release_post.py \
--project "ScanCode Toolkit" \
--version "32.0.0" \
--release-url "https://github.com/aboutcode-org/scancode-toolkit/releases/tag/v32.0.0"

This writes a dated file (for example,
``docs/source/news/posts/2026-01-18-scancode-toolkit.rst``). Stage, commit, and
open a PR to `aboutcode-org/aboutcode`.

Automate with GitHub Actions (template)
=======================================

Add a workflow in the releasing project that runs on ``release`` events and
opens a PR to the aboutcode site. This template assumes you store a token with
push rights to your fork of ``aboutcode-org/aboutcode`` as
``ABOUTCODE_DOCS_PAT``.

.. code-block:: yaml

name: Publish release news
on:
release:
types: [published]

jobs:
announce:
runs-on: ubuntu-latest
steps:
- name: Check out aboutcode site
uses: actions/checkout@v4
with:
repository: ${{ github.repository_owner }}/aboutcode
token: ${{ secrets.ABOUTCODE_DOCS_PAT }}

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install deps (docs extra)
run: |
python -m pip install --upgrade pip
pip install -e .[docs]

- name: Generate news post
run: |
python tools/generate_release_post.py \
--project "${{ github.event.repository.name }}" \
--version "${{ github.event.release.tag_name }}" \
--release-url "${{ github.event.release.html_url }}"

- name: Create pull request
uses: peter-evans/create-pull-request@v6
with:
token: ${{ secrets.ABOUTCODE_DOCS_PAT }}
branch: release-news/${{ github.event.repository.name }}-${{ github.event.release.tag_name }}
commit-message: "Add news post for ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}"
title: "Add news post for ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}"
body: "Automated release news post for ${{ github.event.release.html_url }}"

Notes and expectations
======================
- Keep posts concise: title, short summary, highlight bullets, and links.
- The script is idempotent per date + project; reruns on the same day overwrite
the file unless a new version is provided.
- Review the generated post before merging; adjust highlights as needed.
- If you cannot grant a token to push directly, run the workflow in a fork and
open a PR manually.
10 changes: 6 additions & 4 deletions docs/source/contributing/writing_good_commit_messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ The main style points are these:

Subject:

- Add a issue number at the end of the line when available as in "#234"
- Prefer full issue URLs (e.g. ``https://github.com/aboutcode-org/aboutcode/issues/234``)
to keep references valid if code moves to another repo.
- Shorthand ``#234`` is acceptable only when the work is guaranteed to remain in
the same repository.
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
Expand All @@ -38,9 +41,8 @@ Body:

Other comments:

We like to suffix the subject line with an issue number. If this was a
trivial change it may not have one though. If it had one a you would use
``#156`` as a suffix to the first line.
We like to suffix the subject line with an issue reference. Use the full URL by
default; shorthand ``#156`` only if the commit will stay in the same repository.

We like to tell why the commit is there and use an imperative style, like
if you were giving an order to the codebase with your commit:
Expand Down
19 changes: 19 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ Overview

aboutcode-project-overview

********
Standards
********

.. toctree::
:maxdepth: 2

standards/index

************
Contributing
************
Expand All @@ -36,6 +45,15 @@ Contributing

contributing

****
News
****

.. toctree::
:maxdepth: 1

news/index

******
Others
******
Expand All @@ -45,4 +63,5 @@ Others

aboutcode-data/abcd
archive
privacy-policy
license
18 changes: 18 additions & 0 deletions docs/source/news/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
############################
News and release updates
############################

AboutCode projects can publish release announcements here so readers see updates
in one place.

- For instructions on generating a post automatically, see
:doc:`../contributing/release_news`.
- Posts live under the ``news/posts`` directory and are typically created by the
automation script in ``tools/generate_release_post.py``.

.. toctree::
:maxdepth: 1
:glob:

overview
posts/*
18 changes: 18 additions & 0 deletions docs/source/news/overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#############################
How release posts are structured
#############################

Release posts are short and consistent so they can be generated automatically.
Each post includes:

- A title in the form ``<Project> <version> released``.
- A one-paragraph summary and bullet points for highlights.
- A link to the project release page.
- Optional links to changelogs, installation notes, or SBOMs if available.

Posts are stored in ``docs/source/news/posts`` and named with the date prefix,
for example: ``2026-01-18-scancode-toolkit.rst``.

To add a post, run the helper script (documented in
:doc:`../contributing/release_news`) or author a file manually following the
same structure.
17 changes: 17 additions & 0 deletions docs/source/news/posts/2021-12-17-scancode-io.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
################################
ScanCode.io 21.12.17 released
################################

ScanCode.io 21.12.17 is available. This release delivers pipeline and UI
improvements for scanning and reviewing SBOM data produced by ScanCode Toolkit.

Highlights
==========
- Streamlined pipeline steps for common container and archive workflows.
- Improved result review experience in the web UI.
- Updated dependencies and security fixes.

Links
=====
- Release notes: https://github.com/aboutcode-org/scancode.io/releases
- Project page: https://scancode.io
81 changes: 81 additions & 0 deletions docs/source/privacy-policy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
################
Privacy Policy
################

This page describes how the AboutCode community websites and documentation
handle personal data. It is intentionally simple and covers only what we
currently do. We will update it when practices change.

Scope
=====

- This policy applies to AboutCode-operated sites and documentation, including
the content served from this repository and its published builds
(for example, on Read the Docs).
- Individual AboutCode projects may run their own services (for example,
demo deployments or APIs). Those services may have additional terms; check
their documentation or service pages.

What we collect
===============

- Web server logs created by our hosting providers (for example, the IP
address, requested URL, timestamp, user agent). These are used for routine
operations, troubleshooting, and abuse prevention.
- Information you choose to share when you participate in our communities
(for example, names and emails in commits, issues, or mailing lists, or
profile information in chats). This data is public because you chose to
publish it.
- Optional metrics collected by the platforms we use (for example, GitHub or
Read the Docs may record usage for security and performance). That data is
governed by the platform's own privacy terms.

What we do not do
=================

- We do not sell personal data.
- We do not run advertising or behavioral tracking on the documentation site.
- We do not use third-party analytics or cookies on the documentation site
beyond what the hosting platforms require to operate.

How we use the data we have
===========================

- Operate and secure the sites and community services.
- Detect and mitigate abuse (for example, denial of service or spam).
- Improve documentation quality based on aggregated, non-identifying usage
trends made available by the hosting platforms.

Retention
=========

- Hosting platforms control retention of their operational logs; these are
typically short-lived and used for security and performance.
- Public contribution data (for example, issues, commits, and mailing list
archives) remains publicly visible as part of the project history unless
removed for legal or safety reasons.

Sharing
=======

- Hosting providers such as GitHub and Read the Docs process and may share data
under their own terms and applicable law.
- We may disclose data if required to comply with legal obligations or to
protect the security of the project and its community.

Your choices and requests
=========================

- You can avoid publishing personal data by limiting what you include in public
contributions (for example, use a non-identifying email for commits).
- You can request removal of personal data that appears in our documentation or
project materials when feasible and legally permissible.
- For analytics or cookies controlled by the hosting platforms, refer to their
privacy settings and policies.

Contact
=======

Questions or requests about this policy can be sent to **info@aboutcode.org**.

Last updated: 2026-01-18
42 changes: 42 additions & 0 deletions docs/source/standards/ABC-0000-template.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
##########################
ABC-0000: Title goes here
##########################

:Status: Draft
:Created: 2026-01-18
:Authors: Your Name <you@example.com>
:Related: (issue/PR links)

Summary
=======
A short, reader-friendly summary (3–5 sentences) of the proposal.

Motivation
==========
- What problem are we solving?
- Why now? Who benefits?

Proposal
========
- The concrete change being proposed (policies, standards, processes).
- Scope: which AboutCode projects are affected?
- Defaults and configuration (if applicable).

Impact
======
- Benefits and trade-offs.
- Migration/rollout steps (if any).
- Compatibility considerations for downstream projects.

Alternatives considered
=======================
- Briefly list rejected or non-chosen options and why.

Adoption and follow-up
======================
- How this will be enforced (lint, CI, docs, checklists, etc.).
- Owners for ongoing maintenance, if needed.

Changelog for this ABC
======================
- 2026-01-18: Initial draft
42 changes: 42 additions & 0 deletions docs/source/standards/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
###############################
AboutCode proposals (ABC series)
###############################

Org-wide standards and policies are captured as AboutCode proposals, numbered
``ABC-XXXX``. Each proposal lives in this repository, is reviewed in a Pull
Request, and—once accepted—serves as the canonical reference for the topic
(coding standards, security practices, governance, etc.).

Process (lightweight)
=====================
- Copy the template at :doc:`ABC-0000-template` to a new file named
``ABC-<number>-<short-slug>.rst``.
- Open a PR in this repo adding the new proposal under ``docs/source/standards``.
- Reviewers discuss in the PR; when accepted, the status becomes **Accepted**.
- If a proposal is replaced or declined, set status to **Superseded** or
**Rejected** but keep the document for history.

Numbering
=========
- Use four digits: ``ABC-0001``, ``ABC-0002``, …
- Start at 0001 for new proposals (coordinated by the PR author/reviewer to
avoid collisions).

Statuses
========
- **Draft**: proposed, under discussion
- **Accepted**: approved and in effect
- **Superseded**: replaced by a newer ABC
- **Rejected/Withdrawn**: will not proceed

Where these are published
=========================
- Source lives in this repo under ``docs/source/standards``.
- Built docs (e.g., Read the Docs) will include them so all projects can link to
the canonical copy.

.. toctree::
:maxdepth: 1

ABC-0000-template

Loading