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

docs: add guides on forms & structured properties #10340

Merged
merged 17 commits into from
May 21, 2024

Conversation

yoonhyejin
Copy link
Collaborator

@yoonhyejin yoonhyejin commented Apr 19, 2024

Maggie's open questions:

  • Get alignment on following naming conventions:
    • Documentation Forms; Verification is a type of Documentation Form
    • Custom Property, Structured Property

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@yoonhyejin yoonhyejin changed the title feat: add guides on forms & structured properties docs: add guides on forms & structured properties Apr 19, 2024
@github-actions github-actions bot added the docs Issues and Improvements to docs label Apr 19, 2024
@yoonhyejin yoonhyejin marked this pull request as draft April 19, 2024 10:46
covers Custom and Structured Properties; includes screenshots
@yoonhyejin yoonhyejin requested a review from hsheth2 May 20, 2024 01:00
@yoonhyejin yoonhyejin marked this pull request as ready for review May 20, 2024 01:00
@@ -0,0 +1,156 @@
import FeatureAvailability from '@site/src/components/FeatureAvailability';

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@maggiehays you need to import tabs/tabitems first to use tabs

</TabItem>
</Tabs>

:::Note
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
:::Note
:::note

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

i think this is because the adminition is case-sensitive : https://docusaurus.io/docs/markdown-features/admonitions

Copy link
Collaborator

@maggiehays maggiehays left a comment

Choose a reason for hiding this comment

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

@yoonhyejin this first pass is ready to go!

Not a merge blocker, but I noticed the sidebar is adding these two feature guides out of ABC order and appending them to the top of the section. If it's a quick fix, let's slot it in, otherwise let's get this PR merged to unblock @anshbansal
CleanShot 2024-05-20 at 22 20 51

@yoonhyejin
Copy link
Collaborator Author

@maggiehays just pushed a quick fix on the sidebar order!

@yoonhyejin yoonhyejin merged commit 7f37c6f into master May 21, 2024
33 checks passed
@yoonhyejin yoonhyejin deleted the docs/structured-properties-and-forms branch May 21, 2024 09:12
sleeperdeep pushed a commit to sleeperdeep/datahub that referenced this pull request Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and Improvements to docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants