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

build(docs): Update api-markdown-documenter #17468

Merged
merged 26 commits into from Sep 28, 2023

Conversation

Josmithr
Copy link
Contributor

@Josmithr Josmithr commented Sep 25, 2023

Updates the dependency on @fluid-tools/api-markdown-documenter and applies necessary fixes to accommodate breaking changes in the library.

Changes include:

  • Add custom DocumentationNode implementation AlertNode (which was previously a type in the library, but was removed)
    • See alert-node.js and custom-renderers.js
  • Specifying a custom createDefaultLayout lambda
    • Allows us to use the custom AlertNode, and will allow us to more flexibly adjust page layout in the future.
    • See api-documentation-layout.js

@github-actions github-actions bot added area: website base: main PRs targeted against main branch labels Sep 25, 2023
Josmithr added a commit that referenced this pull request Sep 26, 2023
… when injecting custom transformations (#17470)

The newly exported utilities are useful when injecting custom
transformation logic. Many are particularly required by the
fluid-framework.com website build, as (partially) demonstrated by
#17468.

The majority of the new exports are available through the root-level
`LayoutUtilities` module export. E.g.,

```typescript
const examplesSection = LayoutUtilities.createExamplesSection(apiItem, config);
```
@Josmithr Josmithr marked this pull request as ready for review September 26, 2023 22:48
@Josmithr Josmithr requested review from msfluid-bot and a team as code owners September 26, 2023 22:48
@Josmithr Josmithr requested a review from a team September 26, 2023 22:49
docs/api-markdown-documenter/alert-node.js Outdated Show resolved Hide resolved
@github-actions
Copy link
Contributor

🔗 Found some broken links! 💔

Run a link check locally to find them. See
https://github.com/microsoft/FluidFramework/wiki/Checking-for-broken-links-in-the-documentation for more information.

linkcheck output


> fluidframework-docs@0.25.0 ci:linkcheck /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test ci:start http://localhost:1313 linkcheck:full

1: starting server using command "npm run ci:start"
and when url "[ 'http://localhost:1313' ]" is responding with HTTP status code 200
running tests using command "npm run linkcheck:full"


> fluidframework-docs@0.25.0 ci:start
> http-server ./public --port 1313 --silent


> fluidframework-docs@0.25.0 linkcheck:full
> npm run linkcheck:fast -- --external


> fluidframework-docs@0.25.0 linkcheck:fast
> linkcheck http://localhost:1313 --skip-file skipped-urls.txt --external

Crawling...

http://localhost:1313/docs/apis/runtime-definitions/
- (1703:37) 'https://..' => https://datatracker.ietf.org/doc/html/rfc4122%29 (HTTP 404)
- (1703:37) 'https://..' => https://datatracker.ietf.org/doc/html/rfc4122%29 (HTTP 404)

http://localhost:1313/docs/build/bundlers/
- (843:233) 'here' => https://github.com/microsoft/FluidFramework/blob/a4c38234a920abe9b54b1c26a14c0a8e430cd3fa/packages/tools/webpack-fluid-loader/webpack.config.js#L37 (HTTP 200 but missing anchor)

http://localhost:1313/docs/deployment/service-options/
- (848:72) 'Routerli..' => https://github.com/microsoft/FluidFramework/tree/main/server#readme (HTTP 200 but missing anchor)
- (850:168) 'Routerli..' => https://github.com/microsoft/FluidFramework/tree/main/server#readme (HTTP 200 but missing anchor)

http://localhost:1313/docs/faq/
- (927:87) 'Routerli..' => https://github.com/microsoft/FluidFramework/tree/main/server#readme (HTTP 200 but missing anchor)

http://localhost:1313/docs/testing/telemetry/
- (848:3) 'ILoaderP..' => https://github.com/microsoft/FluidFramework/blob/main/packages/loader/container-loader/src/loader.ts#L313 (HTTP 200 but missing anchor)


Summary of most serious issues:

http://localhost:1313/docs/apis/runtime-definitions/
- (1703:37) 'https://..' => https://datatracker.ietf.org/doc/html/rfc4122%29 (HTTP 404)
- (1703:37) 'https://..' => https://datatracker.ietf.org/doc/html/rfc4122%29 (HTTP 404)


Stats:
  207468 links
    2021 destination URLs
       2 URLs ignored
       5 warnings
       1 errors

 ELIFECYCLE  Command failed with exit code 1.

@Josmithr Josmithr merged commit 2d7b2a2 into microsoft:main Sep 28, 2023
28 checks passed
@Josmithr Josmithr deleted the docs/update-api-markdown-documenter branch September 28, 2023 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: website base: main PRs targeted against main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants