Skip to content

Commit

Permalink
Merge pull request #825 from entando/ENDOC-802
Browse files Browse the repository at this point in the history
ENDOC-802 community docs updates
  • Loading branch information
jyunmitch authored Jun 25, 2024
2 parents 8b7a4b9 + 84c5f32 commit 72f373d
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 64 deletions.
25 changes: 9 additions & 16 deletions vuepress/docs/next/docs/community/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,26 @@

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
Examples of behavior that contribute to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
* Focusing on what is best not just for us as individuals but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
Expand Down Expand Up @@ -78,7 +71,7 @@ the consequences for any action they deem in violation of this Code of Conduct:
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
**Consequence**: A private written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

Expand Down Expand Up @@ -108,7 +101,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand All @@ -117,8 +110,8 @@ the community.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
version 2.1, available at
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
Expand Down
32 changes: 16 additions & 16 deletions vuepress/docs/next/docs/community/contributing.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@

# Contributing to Entando

There are many ways to contribute to Entando including participating in the [Entando Forum](https://forum.entando.com), opening issues on GitHub, [updating documentation](https://github.com/entando/entando-docs/tree/master/vuepress), building bundles using the [Local Hub](../compose/local-hub-overview.md), and contributing directly to the source.
Welcome to the Entando community. There are many ways to participate in the community, including collaborating in the [Entando Forum](https://forum.entando.com), opening issues on GitHub, improving the [documentation](https://github.com/entando/entando-docs/tree/master/vuepress), [building bundles](../../tutorials/create/pb/publish-simple-bundle.md), or contributing directly to the source. Connect and share with other like-minded developers and become part of a learning, growing community.

## Contributing to the Source

Entando welcomes contributions to our source code repositories. This is a brief overview of how to create a pull request for an Entando repository.

If you're new to forks in the git world checkout this guide [Working with Forks](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks)
If you're new to forks in the Git world, checkout this guide, [Working with Forks](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks).

1. Find the repository you want to edit on the Entando GitHub
1. Find the repository you want to edit on the Entando GitHub.
* <https://github.com/entando>
* <https://github.com/entando-k8s>
2. Create a fork of the repository you want to update
3. Make your changes or updates on your fork. We recommend making your changes on a branch so that you can update your commits as needed before creating your PR
4. Submit a PR against the main (or master) branch of the repository you're working against. If you're fixing a specific issue reference that issue number in the notes and linked issues
5. Watch the automated builds to make sure everything passes
6. The Entando team will merge your changes!

2. Create a fork of the repository you want to update.
3. Make the changes or improvements on your fork. We recommend making the changes on a branch so that you can update your commits as needed before creating the PR.
4. Submit a PR against the main (or master) branch of the repository you're working against. If you're fixing a specific issue, reference that issue number in the notes and linked issues.
5. Watch the automated builds to make sure everything passes.
6. The Entando team will merge your pull request upon review!

## Code Style and Formatting
Most Entando repositories enforce code style rules. References and setup for the main
source types are provided below.

### Java
Java rules are based on checkstyle and PMD can be found at in the [entando-code-style](
Java rules based on Checkstyle and PMD can be found in the [entando-code-style](
https://github.com/entando/entando-code-style) project. There are configuration files for Intellij, Eclipse, and Netbeans for automated formatting.

### Javascript

Code style and formatting rules for all Entando javascript projects are enforced by linters in every project. For a reference example see: .sass-lint.yml and .eslintrc.js in the [App builder](https://github.com/entando/app-builder)
Code style and formatting rules for all Entando Javascript projects are enforced by linters in every project. For a reference example see: `.sass-lint.yml` and `.eslintrc.js` in the [App builder](https://github.com/entando/app-builder)

In the future these rules will be replaced by Prettier.
In the future these rules will be replaced by Prettier. <!-- Should this line be removed? -->

### Find the Code

Entando source can be found on GitHub in the following organizations.
* <https://github.com/entando>
* <https://github.com/entando-k8s>

For an overview of the key projects in both GitHub organizations and their role in the architecture see [Entando Deployment Structure](../reference/deployment-structure.md)
For an overview of the key projects in both GitHub organizations and their role in the architecture, see the [Entando Deployment Structure](../reference/deployment-structure.md)

## Get Help

If you have questions, need help, or want to find out more about contributing join us at
If you have questions, need help, or want to find out more about contributing, join us at:

- [Entando Forum](https://forum.entando.com)
- [Community Slack](https://join.slack.com/t/entandocommunity/shared_invite/zt-g609owdv-2K~YRh8zrI6lqlWo4aFWUw)

## Licenses
The Entando Platform is 100% open source and most Entando repositories are licensed under the LGPL V3.0. The entando-docs repository is one exception with a [CC BY 4.0 license](https://github.com/entando/entando-docs/blob/main/LICENSE). See the LICENSE file in the root directory of a given repository for its specific license information.
The Entando Platform is 100% open source and most Entando repositories are licensed under the LGPL V3.0. The `entando-docs` repository is one exception with a [CC BY 4.0 license](https://github.com/entando/entando-docs/blob/main/LICENSE). See the LICENSE file in the root directory of a given repository for its specific license information.

Entando libraries licensed with LGPL V3.0 that are used to build applications may be linked to proprietary applications. If linked statically, the application code must also be released as LGPL. If the application is linked dynamically to Entando, the proprietary code does not need to be released.

A commercial open source license is provided for the Entando Platform for customers with Gold and Platinum subscriptions. This license permits freely extending or modifying Entando without requiring contribution of confidential IP back to the open source community.
A commercial open source license is provided for customers of the Entando Platform with Gold and Platinum subscriptions. This license permits freely extending or modifying the Platform without requiring the confidential intellectual property (IP) to be returned to the open source community.

26 changes: 10 additions & 16 deletions vuepress/docs/v7.3/docs/community/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,29 @@


# Entando Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
Examples of behavior that contribute to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
* Focusing on what is best not just for us as individuals but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
Expand Down Expand Up @@ -78,7 +72,7 @@ the consequences for any action they deem in violation of this Code of Conduct:
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
**Consequence**: A private written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

Expand Down Expand Up @@ -108,7 +102,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand All @@ -117,8 +111,8 @@ the community.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
version 2.1, available at
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
Expand Down
33 changes: 17 additions & 16 deletions vuepress/docs/v7.3/docs/community/contributing.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,57 @@


# Contributing to Entando

There are many ways to contribute to Entando including participating in the [Entando Forum](https://forum.entando.com), opening issues on GitHub, [updating documentation](https://github.com/entando/entando-docs/tree/master/vuepress), building bundles using the [Local Hub](../compose/local-hub-overview.md), and contributing directly to the source.
Welcome to the Entando community. There are many ways to participate in the community, including collaborating in the [Entando Forum](https://forum.entando.com), opening issues on GitHub, improving the [documentation](https://github.com/entando/entando-docs/tree/master/vuepress), [building bundles](../../tutorials/create/pb/publish-simple-bundle.md), or contributing directly to the source. Connect and share with other like-minded developers and become part of a learning, growing community.

## Contributing to the Source

Entando welcomes contributions to our source code repositories. This is a brief overview of how to create a pull request for an Entando repository.

If you're new to forks in the git world checkout this guide [Working with Forks](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks)
If you're new to forks in the Git world, checkout this guide, [Working with Forks](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks).

1. Find the repository you want to edit on the Entando GitHub
1. Find the repository you want to edit on the Entando GitHub.
* <https://github.com/entando>
* <https://github.com/entando-k8s>
2. Create a fork of the repository you want to update
3. Make your changes or updates on your fork. We recommend making your changes on a branch so that you can update your commits as needed before creating your PR
4. Submit a PR against the main (or master) branch of the repository you're working against. If you're fixing a specific issue reference that issue number in the notes and linked issues
5. Watch the automated builds to make sure everything passes
6. The Entando team will merge your changes!

2. Create a fork of the repository you want to update.
3. Make the changes or improvements on your fork. We recommend making the changes on a branch so that you can update your commits as needed before creating the PR.
4. Submit a PR against the main (or master) branch of the repository you're working against. If you're fixing a specific issue, reference that issue number in the notes and linked issues.
5. Watch the automated builds to make sure everything passes.
6. The Entando team will merge your pull request upon review!

## Code Style and Formatting
Most Entando repositories enforce code style rules. References and setup for the main
source types are provided below.

### Java
Java rules are based on checkstyle and PMD can be found at in the [entando-code-style](
Java rules based on Checkstyle and PMD can be found in the [entando-code-style](
https://github.com/entando/entando-code-style) project. There are configuration files for Intellij, Eclipse, and Netbeans for automated formatting.

### Javascript

Code style and formatting rules for all Entando javascript projects are enforced by linters in every project. For a reference example see: .sass-lint.yml and .eslintrc.js in the [App builder](https://github.com/entando/app-builder)
Code style and formatting rules for all Entando Javascript projects are enforced by linters in every project. For a reference example see: `.sass-lint.yml` and `.eslintrc.js` in the [App builder](https://github.com/entando/app-builder)

In the future these rules will be replaced by Prettier.
In the future these rules will be replaced by Prettier. <!-- Should this line be removed? -->

### Find the Code

Entando source can be found on GitHub in the following organizations.
* <https://github.com/entando>
* <https://github.com/entando-k8s>

For an overview of the key projects in both GitHub organizations and their role in the architecture see [Entando Deployment Structure](../reference/deployment-structure.md)
For an overview of the key projects in both GitHub organizations and their role in the architecture, see the [Entando Deployment Structure](../reference/deployment-structure.md)

## Get Help

If you have questions, need help, or want to find out more about contributing join us at
If you have questions, need help, or want to find out more about contributing, join us at:

- [Entando Forum](https://forum.entando.com)
- [Community Slack](https://join.slack.com/t/entandocommunity/shared_invite/zt-g609owdv-2K~YRh8zrI6lqlWo4aFWUw)

## Licenses
The Entando Platform is 100% open source and most Entando repositories are licensed under the LGPL V3.0. The entando-docs repository is one exception with a [CC BY 4.0 license](https://github.com/entando/entando-docs/blob/main/LICENSE). See the LICENSE file in the root directory of a given repository for its specific license information.
The Entando Platform is 100% open source and most Entando repositories are licensed under the LGPL V3.0. The `entando-docs` repository is one exception with a [CC BY 4.0 license](https://github.com/entando/entando-docs/blob/main/LICENSE). See the LICENSE file in the root directory of a given repository for its specific license information.

Entando libraries licensed with LGPL V3.0 that are used to build applications may be linked to proprietary applications. If linked statically, the application code must also be released as LGPL. If the application is linked dynamically to Entando, the proprietary code does not need to be released.

A commercial open source license is provided for the Entando Platform for customers with Gold and Platinum subscriptions. This license permits freely extending or modifying Entando without requiring contribution of confidential IP back to the open source community.
A commercial open source license is provided for customers of the Entando Platform with Gold and Platinum subscriptions. This license permits freely extending or modifying the Platform without requiring the confidential intellectual property (IP) to be returned to the open source community.

0 comments on commit 72f373d

Please sign in to comment.