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

[website] pick first line from package description #11772

Merged
merged 2 commits into from Sep 1, 2022

Conversation

alpaix
Copy link
Contributor

@alpaix alpaix commented Sep 1, 2022

Currently we truncate the package description on the API overview page to 170 characters. It results with broken html syntax in several places.

The proposed solution is to pick the first line from the package description block rather than truncating the description block with an arbitrary character count.

Before

image

After

image

... rather than truncating the description block with an arbitrary character count
@alpaix alpaix requested a review from a team as a code owner September 1, 2022 00:41
@github-actions github-actions bot added area: website base: main PRs targeted against main branch labels Sep 1, 2022
@Josmithr
Copy link
Contributor

Josmithr commented Sep 1, 2022

Nice catch! Looks good!

docs/themes/thxvscode/layouts/apis/list.html Outdated Show resolved Hide resolved
@github-actions
Copy link
Contributor

github-actions bot commented Sep 1, 2022

🔗 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:3369) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/bold/latest.eot? (HTTP 503)

http://localhost:1313/docs/apis/azure-client
- (945:92) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4 (connection failed)

http://localhost:1313/docs/apis/azure-client/
- (945:92) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4 (connection failed)

http://localhost:1313/docs/apis/azure-client/itokenclaims
- (865:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4 (connection failed)
- (888:213) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4 (connection failed)
- (893:170) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6 (connection failed)
- (898:65) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7 (connection failed)
- (931:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4 (connection failed)
- (938:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6 (connection failed)
- (944:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7 (connection failed)

http://localhost:1313/docs/apis/azure-client/itokenclaims/
- (865:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4 (connection failed)
- (888:213) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4 (connection failed)
- (893:170) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6 (connection failed)
- (898:65) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7 (connection failed)
- (931:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4 (connection failed)
- (938:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6 (connection failed)
- (944:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7 (connection failed)

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)

http://localhost:1313/docs/apis/protocol-definitions
- (1090:92) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4 (connection failed)

http://localhost:1313/docs/apis/protocol-definitions/
- (1090:92) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4 (connection failed)

http://localhost:1313/docs/apis/protocol-definitions/itokenclaims
- (858:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4 (connection failed)
- (881:213) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4 (connection failed)
- (886:170) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6 (connection failed)
- (891:65) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7 (connection failed)
- (924:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4 (connection failed)
- (931:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6 (connection failed)
- (937:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7 (connection failed)

http://localhost:1313/docs/apis/protocol-definitions/itokenclaims/
- (858:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4 (connection failed)
- (881:213) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4 (connection failed)
- (886:170) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6 (connection failed)
- (891:65) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7 (connection failed)
- (924:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4 (connection failed)
- (931:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6 (connection failed)
- (937:7) 'https://..' => https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7 (connection failed)


Stats:
  121350 links
    1311 destination URLs
       1 URLs ignored
      40 warnings
       2 errors


@alpaix alpaix merged commit 7a6808b into microsoft:main Sep 1, 2022
@alpaix alpaix deleted the docs-truncate-description branch September 1, 2022 21:17
@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

3 participants