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

FF.com containers docs updates #11708

Merged
merged 11 commits into from Sep 1, 2022

Conversation

ssimic2
Copy link

@ssimic2 ssimic2 commented Aug 29, 2022

AB#1238

Further clarifications around containers, what they achieve, implications around their lifecycle etc. All in the context of "build with fluid".

@github-actions github-actions bot added documentation Improvements or additions to documentation base: main PRs targeted against main branch labels Aug 29, 2022
@@ -107,72 +114,48 @@ const { container, services } =
await client.getContainer(/*container id*/, schema);
Copy link
Author

@ssimic2 ssimic2 Aug 29, 2022

Choose a reason for hiding this comment

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

We are using container IDs in our telemetry to represent instance of the container runtime. What we call here "container ID" is really "docId" in our telemetry. Clients will often use our telemetry to log/observe errors so this will certainly create confusion. At the very least we likely need more explicit clarification on telemetry/logging docs.

@ssimic2 ssimic2 marked this pull request as ready for review August 30, 2022 16:55
@ssimic2 ssimic2 requested a review from a team as a code owner August 30, 2022 16:55
docs/content/docs/build/containers.md Outdated Show resolved Hide resolved
docs/content/docs/build/containers.md Outdated Show resolved Hide resolved
docs/content/docs/build/containers.md Outdated Show resolved Hide resolved
docs/content/docs/build/containers.md Outdated Show resolved Hide resolved
docs/content/docs/build/containers.md Outdated Show resolved Hide resolved
docs/content/docs/build/containers.md Outdated Show resolved Hide resolved
docs/content/docs/build/containers.md Outdated Show resolved Hide resolved
docs/content/docs/build/containers.md Outdated Show resolved Hide resolved
docs/content/docs/build/containers.md Outdated Show resolved Hide resolved
docs/content/docs/build/containers.md Show resolved Hide resolved
sashasimic and others added 10 commits August 31, 2022 19:46
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
@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/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)


Stats:
  121581 links
    1317 destination URLs
       1 URLs ignored
       8 warnings
       0 errors


@ssimic2 ssimic2 merged commit bf72253 into microsoft:main Sep 1, 2022
@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
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

4 participants