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

Document TAG Blog Post Process - TAG governance template file #1128

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

leonardpahlke
Copy link
Member

@leonardpahlke leonardpahlke commented Jul 26, 2023

This PR adds a template under the toc/tags/resources/tag-formation-template to document the blog post process within TAGs. This PR #1086 established the /tags/resources structure, and this PR adds content to one of the empty stub files. More PRs will follow to add content to the other template files.
This is the original reference of the process. This file is largely the same in comparison to the original reference, with minor edits.

I wonder if we can reuse other documents here, but I haven't found anything to refer to. The Review principles have a similar flavor to me as the leadership principles.

Signed-off-by: leonardpahlke <[email protected]>
Copy link
Contributor

@raravena80 raravena80 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 writing this @leonardpahlke ! It's very comprehensive.

One comment. Can the outline be a suggestion instead of a requirement? I believe some folks may find the outline useful but others can create blog post without the need for an outline. Additionally, some folks may find going through the outline process extra overhead and be discouraged from writing a blog post from the start.

@leonardpahlke
Copy link
Member Author

@raravena80 Good point. I will update the document. I think we can also make the stage optional. Since it is a template, the TAG can decide for themselves if the draft proposal step is useful to them or not.

@TheFoxAtWork TheFoxAtWork added this to the TOC Repo Updates milestone Aug 17, 2023
@rochaporto rochaporto self-assigned this Oct 10, 2023
feedback2 : 8. Author incorporates feedback
tagleadreview : 9. TAG Lead reviews\n and approves the blog post
signoff : 10. TAG Lead reaches out\n to a ToC Liaison for their final sign-off
merge : 11. TAG Lead merges the blog
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add a final step about advertising the blog post? We can trust feeds to be active, but maybe not a bad idea to add a few suggestions of where to publish a link to the post.

Copy link
Member Author

Choose a reason for hiding this comment

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

I wouldn't write too much about outreach and marketing at this point. But a generic step to "publicize the blog through TAG communication channels" could be a good addition here. WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

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

added an announcement step 3f2174d

reviews2 : 7. Author asks for blog post reviews
feedback2 : 8. Author incorporates feedback
tagleadreview : 9. TAG Lead reviews\n and approves the blog post
signoff : 10. TAG Lead reaches out\n to a ToC Liaison for their final sign-off
Copy link
Contributor

Choose a reason for hiding this comment

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

I was thinking if we need the liaison sign-off at this stage, given the amount of work and reviews that has already been done until we get here? We can keep it, but maybe we add a liaison check between 5 and 6? It could be the liaison has comments right at the start - such as "this topic spawns multiple TAGs, please consider joining forces" or similar. Would prevent these comments from appearing after all is written down and reviewed.

Copy link
Member Author

@leonardpahlke leonardpahlke Oct 17, 2023

Choose a reason for hiding this comment

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

Good point. I have spoken with our TOC Liaisons about it some time ago – as of now, TOC Liaisons need to sign off all artifacts the TAG produces. In general, I think that makes sense, especially for larger works like white papers, standard proposals etc. which require substantial work. In the case of blogs, I would think about proposing making the approval optional.

The reasons for putting the TOC approval to the end of this process is kind of a compromise. The TOC Liaison approval is mandatory, but the TOC does not have a lot of time. The hope is if the approval is placed at the end, the blog post has been already thoroughly reviewed and the TOC does not need to spend a lot of time providing input, replying to questions etc. and its more like a "reading it once and commenting with LGTM". (or reading and commenting to ask for minor changes)

Copy link
Member Author

@leonardpahlke leonardpahlke Oct 17, 2023

Choose a reason for hiding this comment

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

Case to make TOC Liaisons optional: The TOC runs low on time. Most blogs do not have substantial technical depth. The required review puts pressure on the TOC Liaisons to review the blog in a timely manner, without the approval, the process stops.

Case to continue to require approval by the TOC Liaisons for blogs: Most TAGs do not publish too many artifacts, and the ones that are published should be thoroughly vetted. Reviewing blogs does not take too long (limited scope). TOC Liaisons should also know some details of what the TAG is working on (this makes sure that at least one TOC Liaisons has read the blog).

I suppose It depends a bit on time management of the TOC and where to spend it best.

Copy link
Member Author

Choose a reason for hiding this comment

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

Co-authored-by: Ricardo Rocha <[email protected]>
Signed-off-by: Leonard Vincent Simon Pahlke <[email protected]>
@leonardpahlke
Copy link
Member Author

ref "Implementation of an updated TAG formation process" issue: #1043

Signed-off-by: leonardpahlke <[email protected]>
@riaankleinhans riaankleinhans added the process-documentation Doc changes for process and procedures label Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
process-documentation Doc changes for process and procedures
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants