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

Tip headings in messaging cookbook #618

Merged
merged 5 commits into from
Jan 12, 2024
Merged

Tip headings in messaging cookbook #618

merged 5 commits into from
Jan 12, 2024

Conversation

swaldmann
Copy link
Contributor

As the headings already link to those pages and they are easily discoverable in the left sidebar nav I think we can remove those additional hints.

@swaldmann swaldmann enabled auto-merge (squash) January 10, 2024 15:42
@swaldmann
Copy link
Contributor Author

Just one thing: the order of the S4 section + Event Mesh section are in a different order than our sidecar nav. Any preference which should come first?

@renejeglinsky
Copy link
Contributor

I think the whole point of those sections is to contain that link ( ok, a little exaggerated ;) )
Anyways, w/o those links I'd argue that we don't need those intro sections at all because I assume:

  1. Users reading the section here probably haven't noticed the navigation and that there's the guide they're looking for. So they need this tip.
  2. User who see the guide in the navigation do jump directly into that guide and not read these sections at all.

Does it make sense?

@swaldmann
Copy link
Contributor Author

swaldmann commented Jan 11, 2024

I just stumbled over those because the use of a ::: tip toolbox seems atypical there. I think your reasoning makes sense and am totally fine with keeping them.

It initially caught my eye because of its (default) "TIP" heading which I often try to replace by something more descriptive. But after some thought, the default "TIP" might actually be fitting. Maybe replace it by "Tip" to have the same casing as our other headings? replaced it by "Learn more"

@swaldmann
Copy link
Contributor Author

Re-added the links and only replaced some default "TIP"s. WDYT?

@swaldmann swaldmann changed the title Remove redundant tips in messaging cookbook Tip headings in messaging cookbook Jan 11, 2024
Co-authored-by: René Jeglinsky <[email protected]>
@swaldmann swaldmann merged commit 8a35327 into main Jan 12, 2024
4 checks passed
@swaldmann swaldmann deleted the rm-tips branch January 12, 2024 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants