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

User docs for tagging connections #53683

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ian-at-airbyte
Copy link
Contributor

What

Adds a new article to the Airbyte docs describing tagging.

How

Wrote a new article and added it to the sidebar. Also added a new style class so we can render inline SVGs, which makes it easier to represent UI icons that don't have labels.

Review guide

  • /docs/using-airbyte/tagging.md

User Impact

Most of this is pretty intuitive so the user impact will be minimal, but it's good to have it documented just in case.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link

vercel bot commented Feb 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 13, 2025 10:26pm

Copy link
Contributor

@josephkmh josephkmh left a comment

Choose a reason for hiding this comment

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

Thanks for writing this up! I added a few additional suggestions, but approving now because this already looks good to me.

Copy link
Contributor

@josephkmh josephkmh Feb 14, 2025

Choose a reason for hiding this comment

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

There are a few limits to tags we probably want to include in the docs somewhere:

  • A tag name can be maximum 30 characters (PR adding this validation to the UI is in review)
  • Maximum 10 tags can be applied to a given connection
  • Maximum 100 tags can be created in a given workspace

Copy link
Contributor

@josephkmh josephkmh Feb 14, 2025

Choose a reason for hiding this comment

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

Tags can also be created/updated/deleted in the Public API. There is an open PR to update the public API docs to include them. Not sure if it's relevant to mention that on this page, or if we're more UI-centric here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants