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

Documentation correction #13928

Closed
wants to merge 1 commit into from
Closed

Documentation correction #13928

wants to merge 1 commit into from

Conversation

stephaniehobson
Copy link
Contributor

One-line summary

Correct documentation for cta links.

Significant changes and points to review

Grouped the 2 tables with a focus on data-cta-type. Corrected the attributes that trigger the old data structure.

Issue / Bugzilla link

#13238

Testing

make livedocs

@stephaniehobson stephaniehobson added Needs Review Awaiting code review Review: µ Code review time: 5 minutes or less Analytics 📈 labels Nov 23, 2023
Copy link
Member

@alexgibson alexgibson left a comment

Choose a reason for hiding this comment

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

r+wc

+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``data-cta-position`` | Location of CTA on the page (e.g. ``primary``, ``secondary``, ``header``) |
+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


**Old data-cta structure**
Copy link
Member

Choose a reason for hiding this comment

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

I'm a little confused here, since does seem to be talking about an older data-cta pattern that exists (see doc example below your changes).

It looks like data-link-type and data-link-name are even older maybe? Perhaps we should just list all of the outdated / obsolete attributes together?

  • data-cta-name (when used together with data-cta-type, which still exists)
  • data-link-type
  • data-link-name

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I'm confused too. These data-attributes are a bit of a mess.

@alexgibson alexgibson removed the Needs Review Awaiting code review label Nov 24, 2023
@stephaniehobson stephaniehobson deleted the oops branch December 4, 2023 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Analytics 📈 Review: µ Code review time: 5 minutes or less
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants