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 SharedTree to docs #18272

Merged
merged 15 commits into from Jan 5, 2024
Merged

Add SharedTree to docs #18272

merged 15 commits into from Jan 5, 2024

Conversation

Rick-Kirkham
Copy link
Member

@Rick-Kirkham Rick-Kirkham commented Nov 12, 2023

Reviewer Guidance

When referring to the children of objects, I used the words "property" or "node." I did not use the word "field." FWIW, I asked ChatGPT 3.5 and other AIs which is the correct term for JavaScript and TypeScript and they all said "property." Also, ChatGPT pointed out the "field" is used for members of TypeScript classes and a TypeScript class property is wrapped around a field, but is not itself a field, so I think it is potentially misleading to refer to the "fields" of an object.

@Rick-Kirkham Rick-Kirkham requested a review from a team as a code owner November 12, 2023 23:00
@github-actions github-actions bot added area: website documentation Improvements or additions to documentation base: main PRs targeted against main branch labels Nov 12, 2023
docs/content/docs/data-structures/tree.md Outdated Show resolved Hide resolved
docs/content/docs/data-structures/tree.md Outdated Show resolved Hide resolved
docs/content/docs/data-structures/tree.md Outdated Show resolved Hide resolved
@Rick-Kirkham Rick-Kirkham changed the title Add overview of SharedTree to docs Add SharedTree to docs Nov 21, 2023
docs/content/docs/build/dds.md Outdated Show resolved Hide resolved
docs/content/docs/build/dds.md Show resolved Hide resolved
docs/content/docs/build/dds.md Show resolved Hide resolved
docs/content/docs/start/quick-start.md Outdated Show resolved Hide resolved
@Josmithr
Copy link
Contributor

Josmithr commented Jan 3, 2024

Please ignore if this was already the plan, but we should probably wait to merge this until we release the 2.0 beta, otherwise we may cause some confusion.

Copy link
Contributor

@Josmithr Josmithr left a comment

Choose a reason for hiding this comment

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

Since FF 2.0 will only be available in beta in the near future, it seems like we should be careful to note this anywhere we are covering 2.0-specific topics in the docs. E.g. SharedTree.

And for notices about things being deprecated in 2.0, we should probably say "will be deprecated in 2.0" rather than "is deprecated in 2.0".

Copy link
Contributor

github-actions bot commented Jan 5, 2024

🔗 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/api/id-compressor/
- (1277:37) 'https://..' => https://datatracker.ietf.org/doc/html/rfc4122%29 (HTTP 404)
- (1277:37) 'https://..' => https://datatracker.ietf.org/doc/html/rfc4122%29 (HTTP 404)

http://localhost:1313/docs/api/merge-tree/client-class/
- (933:62) 'TypedEve..' => http://localhost:1313/docs/api/client-utils/typedeventemitter-class (HTTP 404)
- (933:62) 'TypedEve..' => http://localhost:1313/docs/api/client-utils/typedeventemitter-class (HTTP 404)

http://localhost:1313/docs/api/sequence/iintervalcollection-interface/
- (928:62) 'TypedEve..' => http://localhost:1313/docs/api/client-utils/typedeventemitter-class (HTTP 404)
- (928:62) 'TypedEve..' => http://localhost:1313/docs/api/client-utils/typedeventemitter-class (HTTP 404)

http://localhost:1313/docs/api/telemetry-utils/eventemitterwitherrorhandling-class/
- (928:62) 'TypedEve..' => http://localhost:1313/docs/api/client-utils/typedeventemitter-class (HTTP 404)
- (1016:26) 'EventEmi..' => http://localhost:1313/docs/api/client-utils#eventemittereventtype-typealias (HTTP 404)
- (928:62) 'TypedEve..' => http://localhost:1313/docs/api/client-utils/typedeventemitter-class (HTTP 404)
- (1016:26) 'EventEmi..' => http://localhost:1313/docs/api/client-utils#eventemittereventtype-typealias (HTTP 404)

http://localhost:1313/docs/build/bundlers/
- (928: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/data-structures/overview/
- (1001:110) 'cause is..' => http://localhost:1313/docs/data-structures/counter/#why-a-specialized-dds (HTTP 200 but missing anchor)

http://localhost:1313/docs/data-structures/sequences/
- (1290:16) 'SharedSt..' => http://localhost:1313/docs/data-structures/string/#examples (HTTP 200 but missing anchor)

http://localhost:1313/docs/data-structures/tree/
- (974:26) 'Shared T..' => https://github.com/microsoft/FluidDemos/shared-tree-demo (HTTP 404)

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

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

http://localhost:1313/docs/start/quick-start-sharedtree/
- (940:0) 'Simple F..' => https://github.com/microsoft/FluidDemos/simple (HTTP 404)
- (950:58) 'http://l..' => http://localhost:3000 (connection failed)

http://localhost:1313/docs/start/tutorial-sharedtree/
- (913:123) 'Simple F..' => https://github.com/microsoft/FluidDemos/simple (HTTP 404)
- (949:163) 'schema.ts' => https://github.com/microsoft/simple/blob/main/src/schema.ts (HTTP 404)
- (991:40) 'fluid.ts' => https://github.com/microsoft/simple/blob/main/src/infra/fluid.ts (HTTP 404)
- (1027:81) 'index.tsx' => https://github.com/microsoft/simple/blob/main/src/index.tsx (HTTP 404)
- (1179:12) 'full cod..' => https://github.com/microsoft/simple (HTTP 404)
- (1095:3) <img> => http://localhost:1313/docs/start/tutorial-sharedtree/images/shared-tree-demo.png (HTTP 404)

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

http://localhost:1313/docs/updates/v1.0.0/
- (931:20) 'Connecti..' => http://localhost:1313/docs/api/container-loader/#connectionstate-enum (HTTP 200 but missing anchor)
- (943:3) 'getConta..' => http://localhost:1313/docs/api/azure-client/azureclient-class/#getcontainerversions-method (HTTP 200 but missing anchor)
- (945:0) 'copyCont..' => http://localhost:1313/docs/api/azure-client/azureclient-class/#copycontainer-method (HTTP 200 but missing anchor)


Stats:
   76129 links
     893 destination URLs
       2 URLs ignored
      11 warnings
      11 errors

 ELIFECYCLE  Command failed with exit code 1.

@Josmithr
Copy link
Contributor

Josmithr commented Jan 5, 2024

@Rick-Kirkham I've set up a staging branch to put all of the content updates for the 2.0 beta. Once we're ready on Monday, we'll merge that branch into main to publish everything at once. I'm re-targeting this PR to that staging branch so we can merge it now and start testing the site updates before Monday. FYI 🙂

@Josmithr Josmithr changed the base branch from main to ffv2-docs-update January 5, 2024 22:57
@Josmithr Josmithr merged commit ec2132a into ffv2-docs-update Jan 5, 2024
28 checks passed
@Josmithr Josmithr deleted the docs/sharedtree branch January 5, 2024 22:58
@Rick-Kirkham
Copy link
Member Author

Rick-Kirkham commented Jan 5, 2024 via email

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 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants