Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): repair generated API documentation so that links between packages are rendered #567

Merged
merged 6 commits into from
Sep 13, 2022

Conversation

sranka
Copy link
Contributor

@sranka sranka commented Sep 13, 2022

Fixes #566

Proposed Changes

  • reference identifiers in api-extractor output are validated against existing identifiers, fix-extracted-api-files.js was modified
  • references to unknown identifiers are fixed automatically, if possible
    • usually a replacement of !~ to simple ! is sufficient to make things work, for example FIXED @influxdata/influxdb-client!~WriteRetryOptions:interface => @influxdata/influxdb-client!WriteRetryOptions:interface
    • there is also a map that fixes a few namings errors produced by api-extractor and a list of id prefixes that are ignored (with a documented explanation)
    • all the fixes are printed to console
  • failure to resolve a documentation reference is reported with 1 exit code
    • all errors are printed together before the process exits
    • yarn apidoc:ci will fail and therefore CI checks will fail on invalid references

Moreover, this PR also upgrades api-extractor and api-documenter to latest version. Some of the issues get resolved with the upgrade.

Checklist

  • CHANGELOG.md updated
  • Rebased/mergeable
  • A test has been added if appropriate
  • yarn test completes successfully
  • Commit messages are conventional

@sranka sranka added this to the 1.30.0 milestone Sep 13, 2022
@sranka sranka changed the title Fix/doc references fix(docs): repair generated API documentation to that links between packages are rendered Sep 13, 2022
@codecov-commenter
Copy link

codecov-commenter commented Sep 13, 2022

Codecov Report

Merging #567 (1a144ff) into master (d5a5382) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #567   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           33        33           
  Lines         1273      1273           
  Branches       306       306           
=========================================
  Hits          1273      1273           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@sranka sranka changed the title fix(docs): repair generated API documentation to that links between packages are rendered fix(docs): repair generated API documentation so that links between packages are rendered Sep 13, 2022
@sranka sranka requested review from bednar and powersj September 13, 2022 08:06
@sranka sranka marked this pull request as ready for review September 13, 2022 08:08
Copy link
Contributor

@bednar bednar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested generated docs by yarn apidoc... it looks good 👍

LGTM 🍻

@sranka sranka merged commit bf92b0a into master Sep 13, 2022
@sranka sranka deleted the fix/doc_references branch September 13, 2022 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing links between packages in the generated documentation
3 participants