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.

Sign up for GitHub

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

Jump to bottom

feat(tree): Add the ability to associate metadata with Node Schema #23321

Draft
wants to merge 53 commits into
base: main
Choose a base branch
from
Draft

feat(tree): Add the ability to associate metadata with Node Schema #23321

wants to merge 53 commits into from

Conversation

Josmithr
Copy link
Contributor

Take 3. If we like this pattern, I'll merge these changes back into the current PR branch.

Josmithr and others added 30 commits December 12, 2024 21:25
@Josmithr
feat: Support metadata on Object node schema
111f37f
@Josmithr
feat: Add metadata support to map node schema
e611fdd
@Josmithr
feat: Add metadata support to array node schema
72e2398
@Josmithr
test: Recursive schema tests
cbf1056
@Josmithr
feat: Support metadata in simple schema domain, and map "description"…
adcf801 
… to json schema domain
@Josmithr
docs: Expand notes
167f538
@Josmithr
docs: InheritDoc
212eea5
@Josmithr
docs: Update terminology
233db92
@Josmithr
revert: Unintended change
f569711
@Josmithr @noencke
refactor: Apply suggestions from code review
c6455af 
Co-authored-by: Noah Encke <78610362+noencke@users.noreply.github.com>
@Josmithr
docs: Update API reports
37e6088
@Josmithr
refactor: Consistent typing
ccc0be8
@Josmithr
tools: Update spelling dictionary
fb10e72
@Josmithr
refactor: Expose withMetadata function to replace new SchemaFactory…
9e1e1fe 
… parameters
@Josmithr
refactor: Remove unused type
471ae1d
@Josmithr
docs: Update API reports
fc48fe1
@Josmithr @tylerbutler
docs: Update changeset wording
957e202 
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
@Josmithr
revert: Unwanted changes
8abd211
@Josmithr
remove: Unused import
594b1d7
@Josmithr
refactor(test): Replace withMetadata tests with a single test
a94f4c2
@Josmithr
improvement: Make metadata properties readonly
17eca89
@Josmithr
refactor: More consistent typing
6526065
@Josmithr
docs: Add function documentation
7278573
@Josmithr
refactor: Stricter typing and remove readonly type modification
465643b
@Josmithr
test: Simplify test
d477c93
@Josmithr
revert: Unwanted change
6a20d59
@Josmithr
refactor: Simplify typing
901db32
@Josmithr
remove: Unused import
2be529d
@Josmithr
refactor: Type param ordering
6a76aa2
@Josmithr
docs: Small changeset wording update
aadfddf
Josmithr and others added 14 commits December 12, 2024 21:25
@Josmithr
revert: Type signature change
0d273a0
@Josmithr @alexvy86
docs: Update changeset wording
6e4ea43 
Co-authored-by: Alex Villarreal <716334+alexvy86@users.noreply.github.com>
@Josmithr
docs: Update changeset to make potential breaking nature more explicit
61cbeea
@Josmithr
docs: Update wording
93a30e6
@Josmithr
docs: Fix comment
845082a
@Josmithr
docs: Restore removed test condition, but commented out with an expla…
fe46a27 
…nation comment
@Josmithr
test: Expand test
ed4fb02
@Josmithr
docs: Remove comment
2a9ade4
@Josmithr
docs: Add link to previous release notes in changeset
a294afc
@Josmithr
refactor: Required parameter
af07d78
@Josmithr
fix(docs): Configure SWA to never emit trailing slashes for website U…
79c0716 
…RLs (microsoft#23286)

Ensures consistent relative file path link behavior by ensuring resolved
site URLs never include a trailing slash. See
<https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#never>

Also makes some small fixes to config files for local development.


[AB#25895](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/25895)
@Josmithr
fix(docs): Better trailing slash omission (microsoft#23304)
d4e8232 
Partial reversion of microsoft#23286.

SWA's implementation of `"trailingSlash": "never"` is currently flawed.
The resulting redirect ends up exposing the underlying SWA URL of the
site, rather than our configured front door URL. E.g.
`https://fluidframework.com/docs/concepts/signals/` ends up redirecting
to
`https://salmon-sand-0b7fa7c1e.1.azurestaticapps.net/docs/concepts/signals`.
- See Azure/static-web-apps#1036

This PR removes that configuration flag, and instead leverages
Docusaurus's
[trailingSlash](https://docusaurus.io/docs/api/docusaurus-config#trailingSlash)
configuration option to not emit trailing slashes.

This required updating a handful of relative URL links to use file path
links. The guidance documentation in the README has been updated to
offer new guidance around relative links in light of new learnings.

[AB#25895](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/25895)
@Josmithr
refactor: Restore to original API model
ef4c6d6
@Josmithr
docs: Update API reports
2ddb09e
@github-actions github-actions bot added area: contributor experience area: dds Issues related to distributed data structures area: dds: tree area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct changeset-present public api change Changes to a public API base: main PRs targeted against main branch labels Dec 12, 2024
@github-actions github-actions bot added the area: examples Changes that focus on our examples label Dec 19, 2024
@github-actions GitHub Actions
Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  170138 links
    1596 destination URLs
    1825 URLs ignored
       0 warnings
       0 errors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
area: contributor experience area: dds: tree area: dds Issues related to distributed data structures area: examples Changes that focus on our examples area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct base: main PRs targeted against main branch changeset-present public api change Changes to a public API
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Josmithr