Skip to content

[19.0][IMP] base_tier_validation: rewrite the documentation - #86

Open
bosd wants to merge 1 commit into
OCA:19.0from
bosd:19.0-imp-base_tier_validation-readme
Open

bosd wants to merge 1 commit into
OCA:19.0from
bosd:19.0-imp-base_tier_validation-readme

Conversation

@bosd

@bosd bosd commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

The readme of base_tier_validation was written for developers and had aged:

  • It linked to purchase_tier_validation in purchase-workflow; it now points to this repository (without a version, so the link does not age) rather than listing every *_tier_validation module.
  • The only known issue on the roadmap was fixed in 13.0.1.2.2.
  • Nothing explained what tier validation exceptions are for, or in which order the reviews are done (highest sequence first, which surprises people).

This rewrites DESCRIPTION and CONFIGURE in functional terms and adds CONTEXT and USAGE. The developer notes are kept, shorter, at the end of the description.

Some open PRs add a few lines to CONFIGURE.md (#41, #46, #47, #83) or ROADMAP.md (#80); whichever merges second needs a small rebase, which I'll do.

@OCA-git-bot

Copy link
Copy Markdown
Contributor

Hi @LoisRForgeFlow,
some modules you are maintaining are being modified, check this out!

@OCA-git-bot OCA-git-bot added mod:base_tier_validation Module base_tier_validation series:19.0 labels Oct 6, 2026
@bosd
bosd force-pushed the 19.0-imp-base_tier_validation-readme branch from 82d4d9d to 126c44f Compare October 6, 2026 15:07
@bosd bosd added the documentation Improvements or additions to documentation label Oct 6, 2026
Explain what the module does in functional terms, and point to the
tier-validation repository for the modules that use it instead of the
old purchase-workflow link. Add a context and a usage section.
Document the order of the reviews (highest sequence first), Approve
by sequence, and what tier validation exceptions are for. Drop the
only known issue, fixed in 13.0.1.2.2.
@bosd
bosd force-pushed the 19.0-imp-base_tier_validation-readme branch from 126c44f to dec73b6 Compare October 6, 2026 17:00
@bosd

bosd commented Oct 7, 2026

Copy link
Copy Markdown
Contributor Author

@axelpriem Can you please review?

@axelpriem

Copy link
Copy Markdown
Contributor

@axelpriem Can you please review?

You want me to review your code, even though I'm not a member of OCA?...

@bosd

bosd commented Oct 7, 2026

Copy link
Copy Markdown
Contributor Author

@axelpriem Yes, Well, this one is actually only about the documentation.
The reason I asked, is because I wanted to have a fresh pair of 👀 eyes on it :)

@axelpriem

Copy link
Copy Markdown
Contributor

@axelpriem Yes, Well, this one is actually only about the documentation. The reason I asked, is because I wanted to have a fresh pair of 👀 eyes on it :)

I don't mind doing it, but I know very little about the module and the functionality in it. It was just failing my GIT pipelines in a project, that's why I asked for the change. So I'm not sure if my review of the readme files would be useful...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation mod:base_tier_validation Module base_tier_validation series:19.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants