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

Add shared counter article #11252

Merged
merged 47 commits into from Aug 23, 2022
Merged

Conversation

Josmithr
Copy link
Contributor

@Josmithr Josmithr commented Jul 22, 2022

Fills in SharedCounter article for fluidframework.com.

Also...

  • cleans up some surrounding documentation and related source-code comments.
  • removes some empty articles that were hidden from the website, and had no comments or anything in them
  • updates page ordering to reflect current navigation

@github-actions github-actions bot added area: dds Issues related to distributed data structures documentation Improvements or additions to documentation base: main PRs targeted against main branch labels Jul 22, 2022
@Josmithr Josmithr marked this pull request as ready for review July 22, 2022 22:15
@Josmithr Josmithr requested review from a team as code owners July 22, 2022 22:15
@ssimic2
Copy link

ssimic2 commented Aug 8, 2022

Nice work @Josmithr !! Love the attention to detail!

docs/content/docs/data-structures/counter.md Outdated Show resolved Hide resolved
docs/content/docs/data-structures/counter.md Outdated Show resolved Hide resolved
docs/content/docs/data-structures/counter.md Outdated Show resolved Hide resolved
docs/content/docs/data-structures/counter.md Outdated Show resolved Hide resolved
docs/content/docs/data-structures/counter.md Outdated Show resolved Hide resolved
docs/content/docs/data-structures/counter.md Show resolved Hide resolved
docs/content/docs/data-structures/counter.md Show resolved Hide resolved
docs/content/docs/data-structures/counter.md 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 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: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:2427) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/normal/latest.svg (HTTP 503)
- (1:2668) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/semibold/latest.eot? (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)
- (1:3369) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/bold/latest.eot? (HTTP 503)
- (1:3811) url(...) => https://c.s-microsoft.com/static/fonts/segoe-ui/west-european/bold/latest.svg (HTTP 503)

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

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


Stats:
  118202 links
    1300 destination URLs
       1 URLs ignored
       8 warnings
       9 errors


Copy link
Contributor

@skylerjokiel skylerjokiel left a comment

Choose a reason for hiding this comment

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

We also need to add the @fluidframework/shared-counter api to our site as well. Let's not block though I've captured that work here. Task 1659: Add @fluidframework/shared-counter api to ff.com

@Josmithr Josmithr merged commit 632468f into microsoft:main Aug 23, 2022
@Josmithr Josmithr deleted the add-shared-counter-article branch August 23, 2022 16:58
@github-actions
Copy link
Contributor

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: dds Issues related to distributed data structures base: main PRs targeted against main branch documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants