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

Add publishing guidelines #1270

Merged
merged 9 commits into from
Jun 17, 2024
Merged

Add publishing guidelines #1270

merged 9 commits into from
Jun 17, 2024

Conversation

anvega
Copy link
Contributor

@anvega anvega commented Jun 9, 2024

This PR introduces a new document, guidelines.md, which outlines the publishing guidelines and standards for the CNCF Technical Advisory Group. The purpose of these guidelines is to ensure the production of high-quality, consistent, and impactful publications. Key points include content quality, structure and organization, writing style, technical accuracy, technical rigor, references and citations, review and revision, and formatting and presentation. These guidelines will help authors produce valuable resources for the community while maintaining a low-friction, enjoyable publishing process.

The guidelines emphasize the importance of considering these standards upfront to ease the burden on volunteers who handle proofing and editorial work.

Copy link

netlify bot commented Jun 9, 2024

Deploy Preview for tag-security ready!

Name Link
🔨 Latest commit 1f7b9ec
🔍 Latest deploy log https://app.netlify.com/sites/tag-security/deploys/666c728b9970cc000838a480
😎 Deploy Preview https://deploy-preview-1270--tag-security.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@anvega anvega force-pushed the anvega-guidelines branch 2 times, most recently from 24a1cc1 to 77d3c6b Compare June 10, 2024 04:42
@brandtkeller
Copy link
Collaborator

This is a great outline for guidance and enabling the TAG to continue to iterate.

I imagine there are a great many points that could be added - and I don't want to keep this from merge otherwise - but I do see one partially covered topic that I believe lies somewhere in the lifecycle of publications.

Do we want to include any guidance for efforts we target as high-value and as such want to keep publishing versioned updates? Do we have an obligation to do so with the items we publish or is there an expectation of best effort or otherwise deprecating after some period of time without intent to update?

Willing to take this as a topic outside of this PR.

@eddie-knight
Copy link
Collaborator

I agree with @brandtkeller that publication maintenance should at least be mentioned here. We can elaborate on it later if needed.

On another note, we should also incorporate (merge or reference) existing guidance, such as:

  • governance/paper-process.md
  • governance/publishing-deliverables.md

@anvega
Copy link
Contributor Author

anvega commented Jun 10, 2024

When people are energized about writing, they often aspire to maintain their work long term, thinking of it as a living document. However, static versioned documents are harder to maintain than software projects. In practice, nothing gets updated until something bad enough is spotted or there’s a clear incentive for how dated something becomes. Also people’s priorities shift over time, impacting their ability to keep past work current.

For the dozen publications we have made, only the Security White Paper has seen updated versions or later editions. A few of the Supply Chain publications have had small fixes. We can mention the aspiration for ongoing updates in our guidelines but also acknowledge the reality: maintenance typically happens when there’s a compelling reason. We should encourage regular reviews and collaborative efforts while recognizing that some documents will inevitably become outdated without a strong incentive for revision.

Most importantly, I want authors to focus on writing something that meets these guidelines at the time of writing and only worry about future maintenance once they are done. Any post-completion or future maintenance plans should be included in the other two documents that focus more on the larger process/lifecycle beyond just authoring.

@anvega anvega force-pushed the anvega-guidelines branch from 0e5ca83 to 27bb289 Compare June 10, 2024 19:21
@anvega
Copy link
Contributor Author

anvega commented Jun 10, 2024

I consolidated the three publication guidelines under a single folder and added cross-references between each. I also renamed the new doc on publishing guidelines to authoring guidelines for clarity.

Copy link
Collaborator

@mnm678 mnm678 left a comment

Choose a reason for hiding this comment

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

Thanks for adding this! I left a few minor comments

@anvega anvega requested a review from mnm678 June 11, 2024 20:39
@JonZeolla
Copy link
Contributor

Liking the direction and overall flow

I know the compliance WG has a number of white paper ideas currently, so CC @rficcaglia , Anca, etc. for thoughts/feedback

anvega added 9 commits June 14, 2024 09:40
- Introduce `guidelines.md` to outline publishing standards
- Guidelines cover content quality, structure and organization, writing style, technical accuracy, technical rigor, references and citations, review and revision, and formatting and presentation.
- Emphasize the importance of upfront quality to ease the burden on volunteer proofreaders and editors.
- Aim to maintain low-friction, enjoyable publishing process while ensuring high-quality, impactful publications.

Signed-off-by: Andres Vega <av@monkey.org>
fix line length

Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andres Vega <av@monkey.org>

Update guidelines.md

fix line brakes and spacing

Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andres Vega <av@monkey.org>

Update guidelines.md

fix trailing spaces and heading spacing

Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andres Vega <av@monkey.org>

Update guidelines.md

trailing space

Signed-off-by: Andrés Vega <av@messier42.com>
Consolidated the three markdown files that detail publication under a single folder and added links from each file to the other two.

Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andrés Vega <av@monkey.org>
fix link

Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andrés Vega <av@messier42.com>
@PushkarJ PushkarJ force-pushed the anvega-guidelines branch from 7885c7d to 1f7b9ec Compare June 14, 2024 16:40
@anvega
Copy link
Contributor Author

anvega commented Jun 17, 2024

Thanks for the approval @PushkarJ!

@anvega anvega merged commit d4fc6c7 into cncf:main Jun 17, 2024
8 of 10 checks passed
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.

6 participants