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

What's new contribution guidelines update #385

Merged
merged 26 commits into from
Nov 28, 2023
Merged

Conversation

Eve832
Copy link
Contributor

@Eve832 Eve832 commented Nov 17, 2023

My first pass at a What's new update. Not sure about the content I commented out, I think I remember making an informed decision to delete the info, but I'd like another set of eyes on it. I feel like I still need to leave some information about the workflow involved in pulling cloud rel notes into OSS.

TBD:

  • - Add links
  • - Add links to office hours agenda
  • - Add field for Enablement video in step 1
  • - Add overview info to RADS in braintank and link to this doc
  • - determine if we want to "hide" this content for casual viewers of the toolkit (doesn't matter if it's truly hidden, no visible in the TOC is fine)

@Eve832 Eve832 added the type/docs Docs Squad label used across all Grafana Labs repos label Nov 17, 2023
@Eve832 Eve832 requested a review from imatwawana November 17, 2023 20:39
Copy link
Contributor

github-actions bot commented Nov 17, 2023

Overall readability score: 60.71 (🟢 +0.13)

File Readability
index.md 72.31 (🟢 +5.64)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
index.md 72.31 57.47 8.64 9.2 10.2 6.63
  🟢 +5.64 🟢 +1.73 🟢 +1.01 🟢 +1.1 🟢 +0.59 🟢 +0.37

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.71 47.55 9.57 11.65 12.08 7.3
  🟢 +0.13 🟢 +0.04 🟢 +0.02 🟢 +0.03 🟢 +0.01 🟢 +0.01
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@Eve832 Eve832 marked this pull request as draft November 17, 2023 20:40
Eve832 and others added 2 commits November 17, 2023 12:43
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Eve832 and others added 3 commits November 17, 2023 12:47
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Eve832 and others added 2 commits November 17, 2023 12:48
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: Jack Baldry <[email protected]>
Signed-off-by: Jack Baldry <[email protected]>
@imatwawana imatwawana marked this pull request as ready for review November 23, 2023 16:32
@imatwawana
Copy link
Contributor

@Eve832 - I've added several pieces on here but one of the to do items is still outstanding and you'll definitely want to do a read through to make sure I haven't missed anything that I don't know/didn't remember about the process. Jack and I agreed that we'll fill in specifics about the creating versioned release notes later when that process is clearer.

Co-authored-by: Jack Baldry <[email protected]>
@Eve832 Eve832 changed the title WIP: What's new contribution guidelines update What's new contribution guidelines update Nov 27, 2023
@jdbaldry jdbaldry merged commit 691364a into main Nov 28, 2023
5 checks passed
@jdbaldry jdbaldry deleted the eve/update-whats-new branch November 28, 2023 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label used across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants