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

adding card component and ahref link note #3143

Closed
wants to merge 16 commits into from
Closed

Conversation

mirnawong1
Copy link
Contributor

updating component page to reflect new changes to card component, including the ability to add HTML ahref link inside the body and callout that link prop overrides ahref body links. see loom

#3120 (comment)

What are you changing in this pull request and why?

Checklist

  • Review the Content style guide and About versioning so my content adheres to these guidelines.
  • Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

Adding new pages (delete if not applicable):

  • Add page to website/sidebars.js
  • Provide a unique filename for the new page

Removing or renaming existing pages (delete if not applicable):

  • Remove page from website/sidebars.js
  • Add an entry _redirects
  • Ran link testing to update the links that point to the deleted page

updating component page to reflect new changes to card component, including the ability to add HTML ahref link inside the body and callout that link prop overrides ahref body links. [see loom](https://www.loom.com/share/c34967b5bd2945beb81061b43c4797be?t=80)

#3120 (comment)
@mirnawong1 mirnawong1 requested a review from a team as a code owner April 5, 2023 10:05
@netlify
Copy link

netlify bot commented Apr 5, 2023

Deploy Preview for docs-getdbt-com canceled.

Name Link
🔨 Latest commit cae30d1
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/64812dfa924e3d0008b23e8c

@github-actions github-actions bot added Docs team Authored by the Docs team @dbt Labs size: small This change will take 1 to 2 days to address labels Apr 5, 2023
@mirnawong1 mirnawong1 enabled auto-merge April 18, 2023 08:43
@nghi-ly
Copy link
Contributor

nghi-ly commented May 26, 2023

@mirnawong1 : this PR looks like it's related to PR #3397 . double-checking with you, does it make sense to wrap up 3397 first?

also curious why are there two places for this information. we may have chatted about this a while back and i forgot 😅

@mirnawong1
Copy link
Contributor Author

mirnawong1 commented May 30, 2023

@mirnawong1 : this PR looks like it's related to PR #3397 . double-checking with you, does it make sense to wrap up 3397 first?

also curious why are there two places for this information. we may have chatted about this a while back and i forgot 😅

this pr was created back in April to reflect Breezy's awesome updates. i think i added it here because it's a page component that explains cards, whereas i thought the style guide is for our writing standards. do you think i should move this 'how to add card component' content to pr #3397 ? maybe this (page component page) is the correct location to go into detail about cards and how to configure them?

this is def helpful as i also need to add an add'l functionality that allows us to carousel cards

@nghi-ly
Copy link
Contributor

nghi-ly commented Jun 3, 2023

@mirnawong1 , totally agree with you that this should be documented somewhere since it's custom built.

when i search the docs repo, the only place that links to the adding-page-components.md file is here in the repo's README https://github.com/dbt-labs/docs.getdbt.com/blob/current/README.md#writing-content. looks like it was originally created to document how to use Tabs -- today we're using what's built in to Docusauraus so we don't have to use the <WHCode> tag anymore to simulate tabs.

personally, i like having the Markdown syntax/steps in the style guide itself where the guide describes what the rule/guideline is and also how to implement it. i wonder if this is a signal that maybe the section "Writing content" needs to be re-reviewed a bit, perhaps we've outgrown its original intent.

@mirnawong1
Copy link
Contributor Author

mirnawong1 commented Jun 5, 2023

@mirnawong1 , totally agree with you that this should be documented somewhere since it's custom built.

when i search the docs repo, the only place that links to the adding-page-components.md file is here in the repo's README https://github.com/dbt-labs/docs.getdbt.com/blob/current/README.md#writing-content. looks like it was originally created to document how to use Tabs -- today we're using what's built in to Docusauraus so we don't have to use the <WHCode> tag anymore to simulate tabs.

personally, i like having the Markdown syntax/steps in the style guide itself where the guide describes what the rule/guideline is and also how to implement it. i wonder if this is a signal that maybe the section "Writing content" needs to be re-reviewed a bit, perhaps we've outgrown its original intent.

yea for sure! i didn't want to add it to the readme because i remember i was told we didn't want to pollute it for users, and likewise i was also told the style guide was getting long so I've been very aware of this feedback, which is why i added it to the tabs link under "writing content". i don't have bandwidth right now to rereview the writing content or style guide right but as a temp measure, what about moving over this content to the style guide but also include a blurb in the 'tabs' page so users can go to the style guide for more info?

@nghi-ly
Copy link
Contributor

nghi-ly commented Jun 8, 2023

great callout, @mirnawong1 ! lemme try to take a stab at re-reviewing the "writing content" for us. if i can't get around to it be the end of the week, let's go with your temp measure. does that work for you?

@vercel
Copy link

vercel bot commented Oct 31, 2023

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

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 22, 2023 8:00pm

@mirnawong1
Copy link
Contributor Author

closing PR as there's a lot of convo on this thread and I'm not sure where we left off. pr opened since last apr and I've created a notion process to capture this card component change in a quicker way than a pr, particularly how to add HTML links inside the card.

@mirnawong1 mirnawong1 closed this Jan 8, 2024
auto-merge was automatically disabled January 8, 2024 12:39

Pull request was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs team Authored by the Docs team @dbt Labs size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants