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.

Sign up for GitHub

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

Jump to bottom

Change "What it is" heading in definition template #2242

Closed
nate-double-u opened this issue Jul 19, 2023 · 3 comments
Closed

Change "What it is" heading in definition template #2242

nate-double-u opened this issue Jul 19, 2023 · 3 comments
Labels
maintainers Use this label if PR requires maintainers to take action

Comments

@nate-double-u
Copy link
Member

nate-double-u commented Jul 19, 2023 •
edited by seokho-son
Loading

The heading "What it is" would be more grammatically correct as: "What is it?"

This update would involve changing the template in the Style Guide and updating all the en language terms that have been added so far.

Tasks
Preview Give feedback
No tasks being tracked yet.
@nate-double-u nate-double-u added the maintainers Use this label if PR requires maintainers to take action label Jul 19, 2023
@iamNoah1
Copy link
Collaborator

fine for me :)

@nate-double-u nate-double-u mentioned this issue Jul 19, 2023
Closed
@rolfedh
Copy link
Contributor

rolfedh commented Aug 22, 2023 •
edited
Loading

  • I like the proposed changes, @nate-double-u. Generally, titles that ask questions spur readers' curiosity, engagement, and retention.
  • Although we could express the other section titles as questions, this parallelism isn't essential. I find that variation (versus repetition) increases engagement.
  • I also support the alternative proposal to remove the first subheading (minimalism). Readers assume the first paragraph describes the topic.

@iamNoah1
Copy link
Collaborator

after long discussion about this topic among the maintainers, the consensus is to remove the what it is header. see #2575

@seokho-son seokho-son mentioned this issue Nov 29, 2023
Merged
2 tasks
This was referenced Dec 2, 2023
Closed
Open
@sajibAdhi sajibAdhi mentioned this issue Dec 4, 2023
Merged
2 tasks
@iamNoah1 iamNoah1 mentioned this issue Dec 29, 2023
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
maintainers Use this label if PR requires maintainers to take action
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Updating heading in new word template "What is it?" nate-double-u/cncf-glossary
3 participants
@rolfedh @nate-double-u @iamNoah1