Skip to content

Commit

Permalink
fix(blog): update guidance for linting and spelling
Browse files Browse the repository at this point in the history
Signed-off-by: Brandt Keller <[email protected]>
  • Loading branch information
brandtkeller committed Jul 3, 2024
1 parent 374db91 commit 1b6251d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
7 changes: 4 additions & 3 deletions ci/spelling-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
"HITRUST",
"hotspots",
"hyperconverged",
"Inclusivity",
"intercompatible",
"iscsi",
"Istio",
Expand Down Expand Up @@ -106,25 +107,25 @@
"PEAR",
"pearweb",
"PHP",
"protobuf",
"Pronin",
"protobuf",
"ptree",
"pyproject",
"Ragashree",
"Razzak",
"RBAC",
"Rego",
"Roadmap",
"Ragashree",
"runtimes",
"sandboxed",
"sandboxing",
"Sarbanes",
"Sergey",
"SAST",
"SBOM",
"sdlc",
"seccomp",
"semgrep",
"Sergey",
"Shlomo",
"Sigstore",
"SLSA",
Expand Down
10 changes: 10 additions & 0 deletions governance/blog-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,21 @@ Welcome to the Security TAG (STAG) Blog! Our blog is a platform for sharing insi
## Content Creation

### Topics

- **Cloud Native Projects**: Share updates, features, and success stories.
- **Technical Tutorials**: Provide how-to guides, coding tips, and best practices.
- **Community Stories**: Highlight contributors, events, and community achievements.
- **Opinion Pieces**: Discuss trends, challenges, and the future of open source.

### Writing Style

- **Clarity**: Write in clear, concise language. Avoid jargon unless it's well-explained.
- **Engagement**: Make your post interesting and engaging. Use anecdotes and examples.
- **Accuracy**: Ensure all information is accurate and up-to-date.
- **Inclusivity**: Use inclusive language and be respectful to all readers.

### Formatting

- **Headings**: Use appropriate headings (H1, H2, H3, etc.) to structure your post.
- **Paragraphs**: Keep paragraphs short and focused.
- **Lists**: Use bullet points or numbered lists to highlight key points.
Expand All @@ -27,27 +30,32 @@ Welcome to the Security TAG (STAG) Blog! Our blog is a platform for sharing insi
- **Images**: Include relevant images and graphics to enhance the content.

### Length

- Aim for 500-1200 words. Ensure the content is comprehensive yet concise.

## Submission Review Process

### Submission

1. **Draft**: Write your blog post in a markdown file.
2. **Submission Pull Request**: Submit your draft using the [blog submission template](https://github.com/cncf/tag-security/blob/main/.github/ISSUE_TEMPLATE/blog-submission.md).

### Review

1. **Initial Review**: The collective team will perform an initial review.
2. **Feedback**: You may receive feedback and requests for revisions.
3. **Revisions**: Address the feedback and resubmit your revised draft.
4. **Final Review**: The team conducts a final review to ensure quality.

### Approval

- **Acceptance**: Once approved, your post will be scheduled for publication.
- **Notification**: You will be notified of the publication date - A repo maintainer may update this field prior to merge.

## Value to the Community

### Education

- **Knowledge Sharing**: Help others learn new skills and techniques.
- **Resources**: Provide valuable resources and references.

Expand All @@ -56,10 +64,12 @@ Welcome to the Security TAG (STAG) Blog! Our blog is a platform for sharing insi
- **Innovation**: Encourage innovative thinking and solutions.

### Engagement

- **Discussion**: Foster discussions and interactions within the community.
- **Support**: Offer support and encouragement to fellow community members.

### Growth

- **Visibility**: Gain visibility for your contributions and projects.
- **Network**: Call for contribution to get others involved in initiatives.

Expand Down

0 comments on commit 1b6251d

Please sign in to comment.