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

docs: remove outdated content #478

Merged
merged 4 commits into from
Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,29 @@
# SIG-Release

Welcome to SIG-Release, home of release and feature management.

## Onboarding

Please check out our general [GitHub Onboarding Guide](docs/Eclipse-Tractus-X-GitHub-getting-started.md) and
further information can be found here in the [getting started page](https://eclipse-tractusx.github.io/docs/oss/getting-started) on our web-page. For PI11 Planning please have a look into [PI11-Consortia-Planning](docs/PI11-Planning.md).
If you are new to this repository, you might find the [getting started guide](docs/getting-started.md) useful.
If you are interested in the current state of planning, have a look at our [Release Planning Board](https://github.com/orgs/eclipse-tractusx/projects/26)

## The planning and roadmap process

We follow a coordinated approach to plan improvements of Eclipse Tractus-X. see also [Open Planning and Refinement](docs/Open-Refinement-and-Planning-in-Open-Source-Communities.md).
We follow a coordinated approach to plan improvements of Eclipse Tractus-X. see also [Open Planning and Refinement](docs/open-refinement-and-planning.md).

While every repository in the [eclipse-tractusx](https://github.com/eclipse-tractusx) GitHub organization
has its own issue management, the [release planning board](https://github.com/orgs/eclipse-tractusx/projects/26)
has its own issue management, the [Release Planning Board](https://github.com/orgs/eclipse-tractusx/projects/26)
is used to align the overarching Tractus-X releases.

### How can I get involved

In case you experienced a bug, unexpected behaviour, or you want to propose enhancements to Eclipse Tractus-X,
feel free to use one of the provided [issue templates](https://github.com/eclipse-tractusx/sig-project-management/issues/new/choose) and describe your request.
feel free to use one of the provided [issue templates](https://github.com/eclipse-tractusx/sig-release/issues/new/choose) and describe your request.
Please be aware, that not every feature request can be integrated and that we also cannot treat every issue with the highest priority.

Every Release planning will be kicked off by two public alignment sessions. The dates and further details will be shared via
SebastianBezold marked this conversation as resolved.
Show resolved Hide resolved
[tractusx-dev](https://accounts.eclipse.org/mailing-list/tractusx-dev) mailing list.
In addition to that, you can also find public meetings and info about how to join on our
[Open Meetings](https://eclipse-tractusx.github.io/community/open-meetings) community page.
Issues or bug reports, that should be discussed in these meetings, have to be opened prior to the meeting via
our [issue templates](https://github.com/eclipse-tractusx/sig-project-management/issues/new/choose).
our [issue templates](https://github.com/eclipse-tractusx/sig-release/issues/new/choose).

### What can I expect

Expand Down
49 changes: 0 additions & 49 deletions docs/Eclipse-Tractus-X-GitHub-getting-started.md

This file was deleted.

29 changes: 0 additions & 29 deletions docs/README.md

This file was deleted.

27 changes: 27 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Welcome to the Eclipse Tractus-X GitHub organisation

Thank you for your interest in contributing to Eclipse Tractus-X.
If you are not yet familiar with our project, there are good resources to get you started.

- The most basic requirement to start contribution is a [GitHub account](https://github.com/join)
- There is also a good [Getting started](https://eclipse-tractusx.github.io/docs/oss/getting-started) guide on our project website
- Communication rules and channels can be found in our [Community section](https://eclipse-tractusx.github.io/community/intro/)
- If you are unfamiliar with GitHub as a platform, you might find [this video](https://www.youtube.com/watch?v=w3jLJU7DT5E) useful
- If you are unfamiliar with specific wording, the [GitHub Glossary](https://docs.github.com/en/github/getting-started-with-github/github-glossary) contains a good collection.

## Further Information

- [Eclipse Tractus-X Planning Repository `sig-release`](https://github.com/eclipse-tractusx/sig-release)
- [Eclipse Tractus-X Planning Board](https://github.com/orgs/eclipse-tractusx/projects/26)
- [GitHub Project Board Docs](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)
- [GitHub Get Started](https://docs.github.com/en/get-started)
- [GitHub Docs](https://docs.github.com/en)
- [GitHub YouTube Channel](https://www.youtube.com/github)

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2022,2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/sig-release
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Welcome to our Wiki page on the open refinement and planning processes for our open source community. Effective planning and transparent communication are critical for the success of our open source project. Here, we'll outline how our community can participate in and leverage these processes to ensure smooth and efficient collaboration.
Welcome to our guide on the open refinement and planning processes for our open source community.
Effective planning and transparent communication are critical for the success of our project.
Here, we'll outline how our community can participate and leverage these processes to ensure smooth and efficient collaboration.

## Overview

Expand All @@ -16,18 +18,18 @@ Open refinement and planning allow the community to:

### During Planning

* Release Planning Board will be used from GitHub [Release Planning / Release View](https://github.com/orgs/eclipse-tractusx/projects/26)
* Finally attach all related UserStories/Tasks/Issues that have been planned for that feature
* The Release Planning Board will be used: [Release Planning / Release View](https://github.com/orgs/eclipse-tractusx/projects/26)
* Finally, attach all related UserStories/Tasks/Issues that have been planned for that feature
* Set the target Release milestone

## How to Create Features in the `sig-release` Repository
## How to plan and track features `sig-release`

1. **Issue Creation**: Anyone in the community can suggest a new feature by creating an issue in the `sig-release` repository.
2. **Issue Type**: When creating your issue, it's crucial to specify the `Issue Type`:
* `feature`: For new open features.
* `bug`: For bugs or issues with existing features.
3. **Labels**: Use relevant labels to further categorize and provide context to your feature (in any cases, please select also your specific product label). Other than that, please select the `Prep-PI11` label to indicate that the feature is being prepared for the next release.
4. **Milestone**: Use relevant milestone for the next release, if you already know, it will be implemented. Currently, its `24.03`. Officially, the milestone is set during the planning meeting.
3. **Labels**: Use relevant labels to further categorize and provide context to your feature (in any case, please also select your specific product label).
4. **Milestone**: Use relevant milestone for the next release, if you already know, it will be implemented. Officially, the milestone is set during the planning meeting.

**Good to know:** Use the [Release Planning / Inbox](https://github.com/orgs/eclipse-tractusx/projects/26/views/9) board to add new open features. There is the last row with the functionality to add new issues.

Expand Down Expand Up @@ -104,5 +106,5 @@ We welcome feedback and suggestions on how we can improve our open refinement an
This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2022,2023 Contributors to the Eclipse Foundation
- SPDX-FileCopyrightText: 2022,2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/sig-release