Align docs structure + drop version clutter #228#229
Merged
Conversation
- Add "Versions 4.x target XP 8+" NOTE to docs/index.adoc. - docs/versions.json: advertise 4.x as stable (latest) and 3.x as the second entry (drop the pre-release "next / master" pairing). - enonic-docgen.yml: also trigger on push to 4.x, so every branch listed in versions.json regenerates docs. - Strip historical "added in vX.Y" / "starting from version X.Y" clutter from docs/index.adoc: XP 7 badge, hardcoded 3.2.1 version in the build.gradle snippet, disableHttp2 annotation, KeyStore section marker, and the Compatibility bullets describing pre-4.x transitions. Keep the "preemptive auth not supported" caveat as current-tense guidance.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #229 +/- ##
=========================================
Coverage 91.42% 91.42%
Complexity 156 156
=========================================
Files 9 9
Lines 513 513
Branches 58 58
=========================================
Hits 469 469
Misses 23 23
Partials 21 21 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #228.
Brings
docs/in line with the referenceenonic/lib-corslayout and drops "what was added when" clutter from the current (XP 8) docs. The3.x(XP 7) branch is left untouched — a separate PR against4.xwill cherry-pick just the doc cleanup.Structure
docs/index.adoc: addNOTE: Versions 4.x target XP 8+.near the top.docs/versions.json:4.xbecomesstable(latest: true) with3.xas the second entry (drops the pre-releasenext / masterpairing)..github/workflows/enonic-docgen.yml: also trigger on push to4.x, matching every branch listed inversions.json.Clutter removed from
docs/index.adocimage::…badge/xp-7.+…— XP 7+ shield no longer reflects the target platform (4.x is XP 8+).include 'com.enonic.lib:lib-http-client:3.2.1'→include "com.enonic.lib:lib-http-client:${libVersion}". The hardcoded 3.2.1 was frozen from an earlier version; the placeholder mirrors what lib-cors does.(added in v3.2.0)on thedisableHttp2option.[*v3.0.0+*]on theKeyStore and TrustStore Configurationsection heading.== Compatibility:/lib/xp/http-clientisn't a name XP core defines anyway.KeyStore and TrustStore Configurationsection above and describes a removal (clientCertificate can only be typeof Stream) that new readers don't need to know about.Deliberately kept
Preemptive authentication is not supported. Use an Authorization: Basic <credentials> header instead.bullet — reworded to current tense (dropped the "Starting from version 3.0.0" prefix). This is a functional caveat readers still hit today, not a changelog note.KeyStore and TrustStore Configurationsection body, including theWARNINGaboutcertificates/clientCertificate— current behavior.Compressionsection — current behavior.Verify
docs/versions.jsonre-parses as valid JSON..github/workflows/enonic-docgen.ymlre-parses as valid YAML.docs/index.adocrenders withasciidoclocally (same warnings as lib-cors'index.adocin the same environment — missingsource-highlightbinary, not a doc problem).