Skip to content

Fix #238: Add user portal schema doc#239

Merged
tomschr merged 1 commit intomainfrom
toms/238-user-portal-schema
May 2, 2026
Merged

Fix #238: Add user portal schema doc#239
tomschr merged 1 commit intomainfrom
toms/238-user-portal-schema

Conversation

@tomschr
Copy link
Copy Markdown
Contributor

@tomschr tomschr commented Apr 29, 2026

Describe the portal schema from the perspective of a user trying to add or change the config.

@tomschr tomschr self-assigned this Apr 29, 2026
@tomschr tomschr added the area:documentation Improvements or additions to documentation label Apr 29, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 29, 2026

Coverage Report

For commit 5a24972

Click to expand Coverage Report
  Name                                           Stmts   Miss Branch BrPart  Cover
  --------------------------------------------------------------------------------
+ src/docbuild/models/deliverable.py               180      1     22      0  99.5%
+ src/docbuild/cli/cmd_check/process.py             58      0     22      1  98.8%
+ src/docbuild/models/manifest.py                  111      1     12      1  98.4%
+ src/docbuild/utils/pidlock.py                     79      1     14      1  97.8%
+ src/docbuild/cli/cmd_config/list.py               26      0      8      1  97.1%
+ src/docbuild/cli/cmd_validate/process.py         178      5     52      4  96.1%
+ src/docbuild/cli/callback.py                      35      0     10      2  95.6%
+ src/docbuild/utils/concurrency.py                 69      3     18      1  95.4%
+ src/docbuild/cli/cmd_cli.py                      110      3     16      3  95.2%
- src/docbuild/config/xml/stitch.py                 47      5     12      0  88.1%
- src/docbuild/cli/cmd_metadata/metaprocess.py     215     26     66     13  82.6%
- src/docbuild/cli/cmd_config/validate.py           21      2     12      3  78.8%
- src/docbuild/cli/cmd_check/__init__.py            18      5      2      0  65.0%
- src/docbuild/cli/cmd_build/__init__.py            13      5      0      0  61.5%
- src/docbuild/cli/cmd_metadata/__init__.py         27     10      2      0  58.6%
  --------------------------------------------------------------------------------
+ TOTAL                                           3068     67    746     30  97.0%
  
  47 files skipped due to complete coverage.

@tomschr tomschr force-pushed the toms/238-user-portal-schema branch 3 times, most recently from 150f8ec to 33402ad Compare May 1, 2026 13:29
* Describe the portal schema from the perspective of a
  user trying to add or change the config.
* Amend the glossary with more terms or redefine some
  terms
* Config changes:
  * Use css/custom.css instead of css/style.css
    * Use SUSE font
    * Apply styling for glossary
  * Add glossary processing to conf.py to make letters appear in
    the body and on the right side toc.
@tomschr tomschr force-pushed the toms/238-user-portal-schema branch from 33402ad to 5a24972 Compare May 2, 2026 10:32
@tomschr tomschr marked this pull request as ready for review May 2, 2026 11:05
@tomschr tomschr merged commit 8a1c33d into main May 2, 2026
7 checks passed
@tomschr tomschr deleted the toms/238-user-portal-schema branch May 2, 2026 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant