Cloud Native Platform Engineering Community – Contribute

Contribute: Community Post Guidelines

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

This policy outlines the guidelines for accepting, reviewing, and publishing blog posts on our community platform: blog

Blog posts are an opportunity to foster a diverse and vibrant discussion environment, showcasing a variety of viewpoints from members and the wider open source community.

It is important to note that this Community is not itself a publishing house, and therefore the main focus of the group is to generate conversation and collaboration which will be true for blog posts as well, though to a lesser degree than for writing which is deemed a Community official publication.

Representation of Diverse Viewpoints

Community Voices

Our blog serves as a collective of diverse viewpoints from our community members. We believe in representing a wide array of thoughts, experiences, and perspectives.

Inclusion of Disclaimer

Each post will include a short disclaimer, This blog post represents the viewpoint of its author(s) and does not necessarily reflect an official position or perspective of the Community or any subsidiary working group. See this blog and contributions guidelines for more information on how you too can contribute." If the blog includes information about the authors current workplace or otherwise affiliated products, this must also be disclosed in the disclaimer.

Submission, Review and Acceptance Criteria

Submission Process

Contributors are required to submit their blog posts as pull requests (PRs).

Review Process

The Community content is open for review from anyone with good intentions across the open source community. These reviews can be used to refine the content and help Community leaders determine if the blog will be posted.

Acceptance Criteria

At least one Community leader must approve the blog before it can be published. A non-exhaustive list of things the Community leadership will evaluate is:

Alignment with our community’s ethos and values.
Relevance and usefulness to our community members.
Independence from any one vendor or product.
Originality and clarity of content.

Criteria for Rejection

Misalignment with Group Positions

Submissions fundamentally misaligned with the positions or values upheld by our group will be rejected. With this said, blogs are encouraged to have independent ideas which may at times challenge previous Community publications, blog posts, or other content. This is not inherently an issue if the challenge is done using respect and detailed explanation of the data and experiences that led to this change.

Non-Adherence to Community Standards

Submissions failing to meet our community standards in terms of content quality, relevance, or ethical considerations will be subject to rejection. Content must also adhere to the CNCF Code of Conduct.

Feedback and Appeals

In cases of rejection, contributors will be provided with feedback. An appeal process is available for reconsideration, subject to the discretion of our Community leadership team.

Publication Process

Editing and Finalization

Blog posts may undergo minor editing for clarity, grammar, and format consistency before publication. This will be done through PR reviews, suggestions, or adding a commit to the PR.

Notification of Acceptance

Contributors will be notified of the acceptance of their submission through a GitHub PR approval.

Publication and Promotion

Published posts will be shared on our platform and may be promoted through our social media channels and newsletters. Publication is expected to occur at the date of approval unless a specific date has been previously requested by the author and agreed with the Community leadership team.

Cross-Posting Policy

We actively encourage and support cross-posting content from personal or external blogs. This initiative helps in amplifying diverse voices and perspectives within our community.

Cross-posts must either start on this platform or be published to this platform within 7 calendar days. If your intent is to publish to the community platform blog, we recommend having a publishing window approved before that post is published elsewhere, so that a link to the cross-post may be added. If 7 days are exceeded, the community post may be rejected as unoriginal content.

Amendments to the Policy

This policy is subject to change at the discretion of the group’s leadership, with the aim of continually adapting to the evolving needs of our community and maintaining the highest standards of content quality and diversity.

Acknowledgement

By submitting content to our platform, contributors agree to abide by the terms outlined in this policy.

Contribute: Community Participation

Mon, 01 Jan 0001 00:00:00 +0000

Finding Community

Please follow us on LinkedIn Cloud Native Platforms

Please consider joining the CNPE Community Slack workspace to find out more about how you can participate in the community. The CNPE Community is a place for platform engineering practitioners to share knowledge, collaborate on projects, and learn from each other. CNCF Slack #platform-engineering channel

Types of Community Participation

As a community we work on all kinds of practices, from the technical to the organizational or socio-technical. This work manifests in various contributor-friendly forms.

Research studies
Whitepapers and Research papers
Blog posts
Talks and presentations
Software product and project development
Community events and meetups
Facilitation and contribution to other technical projects and organizations.

For more information on how to submit community content, please see the Blog Post Getting started with contributing in WG Platforms

Types of Community Participants

Platform Engineering is a broad field that encompasses many different practitioner roles and responsibilities. The CNPE Community welcomes participation from all types of community members, including:

End Users
Platform Maintainers
Service Providers
Project Maintainers

Contributing

To get started, please open an issue on the CNPE Community repository using the Website Localization issue type.

This issue type will provide context on the scope of your work and provide guidance on the steps required to complete a localizations.

Contribute: Initiatives and Projects

Mon, 01 Jan 0001 00:00:00 +0000

Initiatives and Projects

As Platform Engineering practices evolve rapidly, the CNPE Community is committed to fostering collaboration and knowledge sharing. We have several active initiatives and projects that are ready for contribution and participation. These initiatives focus on various aspects of platform engineering, from product thinking to maturity assessments.

For information on initiatives, or to propose a new initiative, please see the Initiatives and Projects page.

Contributing

To get started, please open an issue on the CNPE Community repository using the Website Localization issue type.

This issue type will provide context on the scope of your work and provide guidance on the steps required to complete a localizations.

Contribute: Localizations

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Part of what makes the CNCF so amazing is the diversity of people involved and supported by the community. One way we make this community more inclusive is by providing localizations for content where possible. Localizations of course require native speakers to create and maintain them and this post is about how you can do that within the CNPE Community content.

The Platform Engineering artifacts and website are initially developed in English, but we welcome contributions to prepare them for other languages. This is a great way to help make the content accessible to a wider audience and to contribute to the community.

Guidelines

While each localization is unique, we encourage you to familiarlize yourself with past localization PRs and the Kubernetes SIG-Docs localization documentation for general guidelines and lessons learned.

The SIG-Docs team has a much broader remit than this Community requires, so be aware that the workflow including slack channels, opening PRs, and website owner reviews will be done via the same process as all other Community postings, just with the added requirement of a native language speaker review.

It is worth reiterating what the SIG-Docs team has stated:

Localizing all the Kubernetes documentation is an enormous task. It’s okay to start small and expand over time.

Whether you start with a single white paper, or want to expand on an existing language to include more blog posts or content, every little bit will make a difference and is appreciated!

Contributing

To get started, please open an issue on the CNPE Community GitHub repository using the Website Localization issue type.

This issue type will provide context on the scope of your work and provide guidance on the steps required to complete a localizations.

Contribute: Platform Maturity Model examples

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Platform engineering is still an emerging space. The Maturity Model was written and reviewed by over 50 individuals from different countries, business domains, company sizes and experiences. That being said, it is still a reflection of the group who wrote it.

This contribution type is an opportunity to expand that number even more. To add real life examples to the model giving richer details to the current levels.

Guidelines

This contribution type is not asking for a change in the model structure or wording. Therefore any suggestions that would change the content, wording, or even formatting of the model and the descriptions of the aspects should be submitted through the more generic contribution format.

What this is doing is enabling and encouraging end users (companies who do not profit from the implementation or sale of cloud native tooling solutions) to share their experiences in relation to the maturity model.

The intention of these contributions is to make these examples more grounded in concrete examples, ideally supplemented by context (e.g. company size, business domain, etc) and more reading (e.g. links to company blogs).

Contributing

To get started, review the current model are scroll down to the Model Detail section. In this section there is a page per aspect, and each level provides Example Scenario section (e.g. Investment Provisional level).

We are asking for community members to please open a Pull Request (PR) adding your example to the current model version. PRs should be limited to just examples, as other changes such as vocabulary, content, or even formatting of the wider maturity model can be submitted as a separate issue.

The original examples are meant to help readers feel connected to the model aspects and levels. To see themselves in the model, and ideally to see examples of what they could experience if they were to invest in moving to another level within the model. These examples were curated by the group but are not attributed to any one company or exact scenario.

You proposed examples should be succinct summery of the way this specific aspect and level presented in your context. We recommend that you use a fairly neutral voice even when presenting challenges or successes. This maintains the tone that there is not “good” or “bad” maturity, but instead the “right” or “wrong” maturity for you, at this time. In addition, we encourage people to include their company name specifically if allowed, or some small context on the company for comparison (e.g. “a large multi-national bank” provides insight into size, regulation, and domain).

The current examples are mostly between 200-500 characters which may feel challenging at first. Reviewers can help you refine your words so don’t stress too much but also be aware this will be the goal before merging. One way you can manage this is to link out to a separate blog which provides more details if that helps to narrow the focus of your example for this white paper.

Asking for help

If you have any questions about this contribution type, your specific context, the technicalities of opening a PR, or really anything else, please join the CNCF Slack and reach out to #platform-engineering.