Skip to content

Commit

Permalink
Adjust Community to Kyma 2.0 (#578) (#591)
Browse files Browse the repository at this point in the history
* Adjust Community to Kyma 2.0 (#578)

* adjust community to kyma 2.0

* add redirect

use branch instead of fork (#583)

Add content strategy after rebase (#586)

* add content strategy

* add merge with main branch

* fix script

* remove old content

* fix env

* fix path

* move screenshot

Co-authored-by: Nina Hingerl <n.hingerl@sap.com>

Adjust community docs to the new navigation structure (#588)

* Adjust community docs to the new navigation structure

* Fix broken links

* Update docs/guidelines/README.md

Co-authored-by: Nina Hingerl <76950046+NHingerl@users.noreply.github.com>

Co-authored-by: Nina Hingerl <76950046+NHingerl@users.noreply.github.com>

* adjust build-review.sh

Co-authored-by: Nina Hingerl <76950046+NHingerl@users.noreply.github.com>
  • Loading branch information
dbadura and NHingerl committed Sep 30, 2021
1 parent 86295d5 commit d7fc1c8
Show file tree
Hide file tree
Showing 230 changed files with 492 additions and 956 deletions.
35 changes: 33 additions & 2 deletions .kyma-project-io/build-preview.sh
Expand Up @@ -37,26 +37,57 @@ remove-cached-content() {
( rm -rf "${BUILD_DIR}" ) || true
}

merge-community() {
git config --global user.email "ci-website@kyma-project.io"
git config --global user.name "CI/CD"
step "Newest commit"
git log --max-count=1

git checkout -B pull-request
git checkout main
step "Last commit from main"
git log --max-count=1

step "merging changes from pull request to main"
git merge pull-request
}

copy-website-repo() {
git clone -b "main" --single-branch "${WEBSITE_REPO}" "${WEBSITE_DIR}"
git clone -b "website-2.0" --single-branch "${WEBSITE_REPO}" "${WEBSITE_DIR}"
}

build-preview() {
export APP_PREVIEW_SOURCE_DIR="${KYMA_PROJECT_IO_DIR}/.."
export APP_COMMUNITY_SOURCE_DIR="${KYMA_PROJECT_IO_DIR}/../docs"
make -C "${BUILD_DIR}" netlify-community-preview
}

add-redirect() {
echo "/ /community/" > "${BUILD_DIR}"/public/_redirects
}

main() {
step "Remove website cached content"
remove-cached-content
pass "Removed"

step "Merge changes from PR with main branch"
merge-community
step "Merged"

step "Copying kyma/website repo"
copy-website-repo
pass "Copied"

step "Remove old content from community"
rm -rf "${BUILD_DIR}"/content/community
step "Removed"

step "Building preview"
build-preview
pass "Builded"

step "Add redirect"
add-redirect
pass "Added"
}
main
18 changes: 0 additions & 18 deletions .kyma-project-io/collaboration-cag.yaml

This file was deleted.

18 changes: 0 additions & 18 deletions .kyma-project-io/content-guidelines-cag.yaml

This file was deleted.

18 changes: 0 additions & 18 deletions .kyma-project-io/contributing-cag.yaml

This file was deleted.

18 changes: 0 additions & 18 deletions .kyma-project-io/get-started-cag.yaml

This file was deleted.

18 changes: 0 additions & 18 deletions .kyma-project-io/governance-cag.yaml

This file was deleted.

4 changes: 0 additions & 4 deletions .kyma-project-io/labels.yaml

This file was deleted.

18 changes: 0 additions & 18 deletions .kyma-project-io/release-guidelines-cag.yaml

This file was deleted.

18 changes: 0 additions & 18 deletions .kyma-project-io/repository-guidelines-cag.yaml

This file was deleted.

18 changes: 0 additions & 18 deletions .kyma-project-io/technical-guidelines-cag.yaml

This file was deleted.

18 changes: 0 additions & 18 deletions .kyma-project-io/templates-cag.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
@@ -1,3 +1,3 @@
# Code of Conduct

Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](/contributing/01-code-of-conduct.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations.
Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](./docs/contributing/01-code-of-conduct.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
@@ -1,3 +1,3 @@
# Contributing

To contribute to this project, follow our [guidelines and rules](./contributing/02-contributing.md).
To contribute to this project, follow our [guidelines and rules](./docs/contributing/02-contributing.md).
45 changes: 11 additions & 34 deletions README.md
@@ -1,61 +1,38 @@
# Kyma Community

## Overview

Welcome to the Kyma community. Here you can find information on how to join the community, get involved, and improve Kyma code and documentation.

Before you proceed, review the [Code of Conduct](./contributing/01-code-of-conduct.md) and contact us on [Slack](http://slack.kyma-project.io/) for any questions or concerns.

Go directly to the section that you are most interested in:
- [Kyma Community](#kyma-community)
- [Overview](#overview)
- [Product information](#product-information)
- [Contribution](#contribution)
- [Process](#process)
- [Issues](#issues)
- [Collaboration](#collaboration)
- [Guidelines and templates](#guidelines-and-templates)
- [Security](#security)
Before you proceed, review the [Code of Conduct](./docs/contributing/01-code-of-conduct.md) and contact us on [Slack](http://slack.kyma-project.io/) for any questions or concerns.

## Product information

Kyma is a cloud-native application runtime which allows you to connect and extend products in a quick and modern way, using serverless computing and microservice architecture. To get a better idea of what Kyma is and what it does, go [here](manifesto/README.md). To learn what types of users might be most interested in Kyma, see the [Kyma personas](manifesto/personas.md).

To learn more about the product, see the [Kyma repository](https://github.com/kyma-project/kyma/blob/main/README.md).
To get a general idea of what Kyma is and what it does, read [Kyma elevator pitch](manifesto/README.md). Read about the [Kyma personas](manifesto/personas.md) to learn what types of users might be most interested in Kyma. To learn more about the product, visit the [Kyma website](https://kyma-project.io/) or its sources kept in the [GitHub repository](https://github.com/kyma-project/kyma/blob/main/README.md).

Kyma is also on social media. Visit the [website](https://kyma-project.io/) and follow Kyma on [Twitter](https://twitter.com/kymaproject), and [LinkedIn](https://www.linkedin.com/company/kyma-project/).
Kyma is also on social media. Follow Kyma on [Twitter](https://twitter.com/kymaproject) and [LinkedIn](https://www.linkedin.com/company/kyma-project/) to keep updated.

## Contribution

We are an open-source community and the number of contributors is growing. Meet the [Kyma team members](https://github.com/orgs/kyma-project/people) who are the regular contributors and the Kyma founders.

### Process

Before you start to contribute, review the [contribution rules](./contributing/02-contributing.md). To understand better the way the Kyma community works, read about the [working model](./governance/01-governance.md) and learn about the [Special Interest Groups and Working Groups](./collaboration/01-sig-and-wg.md) in Kyma.
Before you start to contribute, review the [contribution rules](./docs/contributing/02-contributing.md). To understand better the way the Kyma community works, read about the [working model](./docs/governance/01-governance.md) and learn about the [Special Interest Groups and Working Groups](./collaboration/01-sig-and-wg.md) in Kyma.

All contributors follow the recommended [Git workflow](./contributing/03-git-workflow.md) that relies on forks, branches, rebasing, and squashing. Review it to ensure that you contribute high-quality code and content to the project.
All contributors follow the recommended [Git workflow](./docs/contributing/03-git-workflow.md) that relies on forks, branches, rebasing, and squashing. Review it to ensure that you contribute high-quality code and content to the project.

### Issues

To request a feature or report a bug, go to the given repository's issue tracker and raise an issue using one of the available templates.
The owners of the repository will review your issue and provide you with their feedback. If you are not certain which repository your issue refers to, open it in the `kyma` repository.

### Collaboration

Feel invited to join the public [Core SIG meetings](https://kyma-community.slack.com/messages/CBP7LKRPS/) where you can contribute to the Kyma development and help us drive it forward. Contact the Kyma team directly on [Slack](https://join.slack.com/t/kyma-community/shared_invite/enQtNDAwNzE4Mjk2NDE3LTJhOTlmZjM5YzkwNmEzNmY3ZjE2MTU2OTMxOGE4ZDM0MmU4ZWRkZGJiODgzNmRmMTYxMDYwNjZiMDAwMTA2OWM) to exchange ideas, ask questions, receive hints and tips, and extend your experience with Kyma.
To request a feature or report a bug, go to the given repository's issue tracker and raise an issue using one of the available templates. The owners of the repository will review your issue and provide you with their feedback. If you are not certain which repository your issue refers to, open it in the `kyma` repository.

## Guidelines and templates

You can also find these guidelines and templates in the `community` repository:

- [Naming](./guidelines/technical-guidelines/01-naming.md) conventions
- Document [templates](./guidelines/templates)
- Overview of the [content strategy](./guidelines/content-guidelines/01-content-strategy.md) and [content guidelines](./guidelines/content-guidelines)
- [Release process](./guidelines/releases-guidelines) details
- [Decisions](./collaboration/sig-core/decisions) made by Kyma team members and the Core SIG.
- [Coding standards](./guidelines/technical-guidelines)

There are also [repository guidelines](./guidelines/repository-guidelines) for the Kyma team members. The guidelines contain a folder, file, and document structure required for a [skeleton Kyma repository](./guidelines/repository-guidelines/repository-template).
- [Content guidelines](./docs/guidelines/content-guidelines) that include the overview of the [content strategy](./docs/guidelines/content-guidelines/01-content-strategy.md) and the general guidelines on how to write and format documentation and graphics.
- [Release guidelines](./docs/guidelines/releases-guidelines) that contain the details regarding Kyma releases
- [Repository guidelines](./docs/guidelines/repository-guidelines) that contain folder, file, and document structure required for a [skeleton Kyma repository](./templates/repository-template)
- [Technical guidelines](./docs/guidelines/technical-guidelines/) that contain coding standards used in the Kyma project
- Document [templates](./templates/resources) for different document types that are used in Kyma

## Security

Expand Down
24 changes: 9 additions & 15 deletions collaboration/01-sig-and-wg.md
Expand Up @@ -22,21 +22,11 @@ The cross-project activities can require the creation of a new WG to address the

The Kyma project is open-source and is available on [GitHub](https://github.com/kyma-project). Although external contributions to the Kyma open-source project are welcome through the public GitHub project, the Kyma teams within the organization largely drive the Kyma development.

To ensure the continuous growth and the "scale-as-you-go-and-need" approach when extending the community, the current structure and governance bodies of Kyma SIGs and WGs are very simple. However, the structure of the community can change depending on the community needs. The [Kyma Steering Committee](/governance/#kyma-steering-committee-kyma-steering-committee) supports the governance of Kyma and the single Core SIG represents it publicly. The aim of the Core SIG is to facilitate the collaboration with external contributors.

## Open SIGs and WGs

The list of public SIGs in Kyma includes:

* [Core SIG](#core-special-interest-group-core-special-interest-group)

## Closed SIGs and WGs

To see the list of closed SIGs and WGs, check the [`archive`](https://github.com/kyma-project/community/tree/main/collaboration/archive) folder.
To ensure the continuous growth and the "scale-as-you-go-and-need" approach when extending the community, the current structure and governance bodies of Kyma SIGs and WGs are very simple. However, the structure of the community can change depending on the community needs. The [Kyma Steering Committee](../docs/governance/02-steering-committee.md) supports the governance of Kyma.

## Organize new SIGs and WGs

To propose a new SIG or WG, go to the [issue tracker](https://github.com/kyma-project/community/issues) in the `community` repository and create a new issue from the **SIG or WG proposal** template. The template contains general information explaining the purpose, the goals of the group, and the criteria for the group assessment and evaluation. Provide the required details and submit the issue. If necessary, contact [Kyma Steering Committee leaders](/governance/#kyma-steering-committee-kyma-steering-committee-members) to verify it.
To propose a new SIG or WG, go to the [issue tracker](https://github.com/kyma-project/community/issues) in the `community` repository and create a new issue from the **SIG or WG proposal** template. The template contains general information explaining the purpose, the goals of the group, and the criteria for the group assessment and evaluation. Provide the required details and submit the issue. If necessary, contact [Kyma Steering Committee leaders](../docs/governance/02-steering-committee.md#members) to verify it.

>**NOTE:** You must have at least five candidates for the new SIG or WG to submit the proposal.
Expand All @@ -63,7 +53,7 @@ To standardize the Special Interest Group and Working Group efforts, create maxi
## General guidelines

All Kyma SIG and WG members agree to these rules:
* Follow the official project guidelines defined in the [**Contributing rules**](/contributing/#contributing-rules-contributing-rules).
* Follow the official project guidelines defined in the [**Contributing rules**](../docs/contributing/02-contributing.md).
* Meet regularly in the agreed frequency, for at least 30 minutes.
* Keep up-to-date meeting notes in a given SIG's folder.
* Maintain related repositories and ensure smooth processing of pull requests.
Expand All @@ -84,13 +74,17 @@ When you join a SIG or a WG, you perform at least one of the following roles:
* **Group representative** - It is a specific group member who represents the group to other groups or the Kyma Steering Committee. This is either the group's leader or any other group member. The choice depends on the topic and the place where the group is represented.

## Close a SIG or WG

When a SIG or WG has completed its goals or there is an explicit request to conclude further work, it has to be closed. The request to close a SIG or WG may come from group members, group leaders, or the Kyma Steering Committee. To close a SIG or WG, group leaders need to:

* Create an issue and accompanying pull request (PR) to close a SIG or WG and add the **decision** label to them.
* Close the remaining open issues of the group or reassign them accordingly, with appropriate comment.
* [Delete the group label](https://help.github.com/en/articles/deleting-a-label) used on the issues or PRs.
* Remove the group from the [list of SIGs](#list-of-sigs) or [list of WGs](#list-of-wgs) in this `README.md` file.
* Move the group folder (together with all subfolders and files) to the [archive](https://github.com/kyma-project/community/tree/main/collaboration/archive) folder.
* Add a `CLOSURE.md` file to the archived group folder. Write it in the form of a blog post that informs about the group's outcomes, achievements, challenges, and lessons learned. Remember to provide links to the relevant material. The PR undergoes a standard review by group members, the Kyma Steering Committee, and is subsequently closed.
* Publish the content of the `CLOSURE.md` in the form of a blog post on the Kyma website or link to it.
* Communicate the closure of a given SIG or WG through the Core SIG.
* Communicate the closure of a given SIG or WG.

### Closed SIGs and WGs

To see the list of closed SIGs and WGs, check the [`archive`](https://github.com/kyma-project/community/tree/main/collaboration/archive) folder.

0 comments on commit d7fc1c8

Please sign in to comment.