Skip to content

Commit d5d0b2a

Browse files
authored
Add newsfragment for #197/#187 (#236)
* Add missing newsfragment file * Add new macro `:pr:` in doc config to link to GitHub pull requests
1 parent dd5af05 commit d5d0b2a

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

changelog.d/187.refactor.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Refactor product schema (:pr:`197`)
2+
3+
These changes reflect broad architectural shifts and naming conventions
4+
throughout the entire configuration system.
5+
6+
* **Rebranding**: The naming convention has shifted from Docserv to Portal.
7+
This is reflected in namespace changes and element renaming
8+
(e.g., ``<product>`` is now part of a portal root).
9+
10+
* **Documentation-First Design**: The schema now heavily utilizes ``db:refname``
11+
and ``db:refpurpose`` annotations for almost every element and attribute.
12+
This allows for automated generation of human-readable documentation directly
13+
from the RNC file.
14+
15+
* **Enhanced Modularity**: The schema now explicitly supports splitting large
16+
configuration files into smaller, more manageable parts. By utilizing
17+
inclusion mechanisms, you can maintain different sections of the portal
18+
(like ``<categories>`` or specific products) in separate files, leading to
19+
a cleaner and more maintainable structure.
20+
21+
* **Implicit Language Logic**: Master/source language identification
22+
has shifted from a boolean attribute (``@default``) to a value-based system.
23+
The schema now assumes ``en-us`` is the source locale for products and deliverables.
24+
25+
* **Migration Tooling**: To facilitate the transition, an XSLT migration
26+
stylesheet is available. This tool automates the conversion of version
27+
6.0 configuration files to the 7.0 format, handling the renaming of
28+
elements, restructuring of attributes, and the removal of deprecated metadata.

docs/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,8 @@
133133
"gh_tree": (f"{gh_repo_url}/tree/main/%s", "%s"),
134134
# Linking to the GH issue tracker:
135135
"gh": (f"{gh_repo_url}/issues/%s", "GH #%s"),
136+
# Linking to a GH pull request:
137+
"pr": (f"{gh_repo_url}/pull/%s", "PR #%s"),
136138
}
137139

138140

0 commit comments

Comments
 (0)