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

docs: Update website workflow docs #11757

Merged
merged 16 commits into from Sep 1, 2022
Merged

Conversation

Josmithr
Copy link
Contributor

@Josmithr Josmithr commented Aug 31, 2022

Based on my current work in the website space, this PR is attempting to improve / fill in workflow guidance for working with the website code (/docs).

It also adds a helper script for running documentation generation in the repo, excluding the website.

@github-actions github-actions bot added area: website base: main PRs targeted against main branch labels Aug 31, 2022
@Josmithr Josmithr changed the title Update website workflow docs docs: Update website workflow docs Aug 31, 2022
@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 linkcheck /home/runner/work/FluidFramework/FluidFramework/docs
> npm run linkcheck:fast -- --external


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

Crawling...

http://localhost:1313/css/style.min.f22f6c22fcc37a0d857a17c9c1202a67c28deef90cc26a52b7539b903f623331.css
- (1:1031) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/light/latest.svg (HTTP 503)
- (1:1184) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semilight/latest.eot (HTTP 503)
- (1:1272) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semilight/latest.eot? (HTTP 503)
- (1:1740) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semilight/latest.svg (HTTP 503)
- (1:3130) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semibold/latest.svg (HTTP 503)
- (1:3286) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/bold/latest.eot (HTTP 503)

http://localhost:1313/docs/apis/core-interfaces/ifluidcodedetailscomparer
- (873:360) 'Array.sort' => https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description (HTTP 200 but missing anchor)
- (877:168) 'https://..' => https://github.com/npm/node-semver#usage (HTTP 200 but missing anchor)
- (885:25) 'Array.sort' => https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description (HTTP 200 but missing anchor)
- (914:25) 'https://..' => https://github.com/npm/node-semver#usage (HTTP 200 but missing anchor)

http://localhost:1313/docs/apis/core-interfaces/ifluidcodedetailscomparer/
- (873:360) 'Array.sort' => https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description (HTTP 200 but missing anchor)
- (877:168) 'https://..' => https://github.com/npm/node-semver#usage (HTTP 200 but missing anchor)
- (885:25) 'Array.sort' => https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description (HTTP 200 but missing anchor)
- (914:25) 'https://..' => https://github.com/npm/node-semver#usage (HTTP 200 but missing anchor)


Summary of most serious issues:

http://localhost:1313/css/style.min.f22f6c22fcc37a0d857a17c9c1202a67c28deef90cc26a52b7539b903f623331.css
- (1:1031) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/light/latest.svg (HTTP 503)
- (1:1184) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semilight/latest.eot (HTTP 503)
- (1:1272) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semilight/latest.eot? (HTTP 503)
- (1:1740) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semilight/latest.svg (HTTP 503)
- (1:3130) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semibold/latest.svg (HTTP 503)
- (1:3286) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/bold/latest.eot (HTTP 503)


Stats:
  121051 links
    1316 destination URLs
       1 URLs ignored
       8 warnings
       6 errors


@Josmithr Josmithr marked this pull request as ready for review August 31, 2022 23:12
@Josmithr Josmithr requested review from msfluid-bot and a team as code owners August 31, 2022 23:12
Copy link
Contributor

@alpaix alpaix left a comment

Choose a reason for hiding this comment

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

lgtm

@Josmithr Josmithr merged commit 52dbea8 into microsoft:main Sep 1, 2022
@Josmithr Josmithr deleted the update-docs-docs branch September 1, 2022 21:31
@github-actions
Copy link
Contributor

github-actions bot commented Sep 1, 2022

This commit is queued for merging with the next branch! Please ignore this PR for now. Contact @microsoft/fluid-cr-infra for help.

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