You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by rz...@apache.org on 2021/10/03 15:49:55 UTC
[tomee-site-generator] branch master updated: Fixes grammar,
typos and broken links in several community related pages
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomee-site-generator.git
The following commit(s) were added to refs/heads/master by this push:
new cf29046 Fixes grammar, typos and broken links in several community related pages
cf29046 is described below
commit cf29046ec765468f62770da4f97784893c273204
Author: Richard Zowalla <rz...@apache.org>
AuthorDate: Sun Oct 3 17:49:49 2021 +0200
Fixes grammar, typos and broken links in several community related pages
---
.../community/contributing/jira-ticket.adoc | 4 +--
.../community/contributing/process-task.adoc | 6 ++--
.../community/contributing/submit-changes.adoc | 6 ++--
.../content/community/contributing/workflow.adoc | 36 ++++++++++------------
src/main/jbake/content/community/sources.adoc | 13 ++++----
src/main/jbake/content/security/security.adoc | 6 ++--
6 files changed, 35 insertions(+), 36 deletions(-)
diff --git a/src/main/jbake/content/community/contributing/jira-ticket.adoc b/src/main/jbake/content/community/contributing/jira-ticket.adoc
index e9b6987..9046de5 100644
--- a/src/main/jbake/content/community/contributing/jira-ticket.adoc
+++ b/src/main/jbake/content/community/contributing/jira-ticket.adoc
@@ -9,11 +9,11 @@ Before you can create tickets, you have to link:https://issues.apache.org/jira/s
== No task without a ticket
Before you start working on a task you should ensure that there is a ticket for your task. +
-Browse JIRA and use the search funktion to find out if there is already a ticket for what you want to pick up.
+Browse JIRA and use the search function to find out if there is already a ticket for what you want to pick up.
If not, create a new one.
== Avoiding conflicts and wasted effort
-If a ticket already exists and is assign to someone you should not start working on this task. +
+If a ticket already exists and is assigned to someone you should not start working on this task. +
If you want to help, contact the assigned person using the mailing list or write a comment in the JIRA ticket.
== Pick up a task
diff --git a/src/main/jbake/content/community/contributing/process-task.adoc b/src/main/jbake/content/community/contributing/process-task.adoc
index 52a2e56..b52a813 100644
--- a/src/main/jbake/content/community/contributing/process-task.adoc
+++ b/src/main/jbake/content/community/contributing/process-task.adoc
@@ -5,9 +5,9 @@
== Fork project repository
-You can work on the xref:community/sources.adoc[source code of TomEE] using github.
-If you don't have a github account, you can link:https://github.com/[sign up here].
-To create your own working area, go to the project link:https://github.com/apache/tomee[TomEE on github] and click on the link "Fork".
+You can work on the xref:../sources.adoc[source code of TomEE] using GitHub.
+If you don't have a GitHub account, you can link:https://GitHub.com/[sign up here].
+To create your own working area, go to the project link:https://github.com/apache/tomee[TomEE on GitHub] and click on the link "Fork".
A forked repository will be created for your account and you will be redirected to it.
== One branch for each ticket
diff --git a/src/main/jbake/content/community/contributing/submit-changes.adoc b/src/main/jbake/content/community/contributing/submit-changes.adoc
index e944b41..5232b42 100644
--- a/src/main/jbake/content/community/contributing/submit-changes.adoc
+++ b/src/main/jbake/content/community/contributing/submit-changes.adoc
@@ -17,11 +17,11 @@ mvn -Pstyle pmd:check
These are relatively quick to run - about a minute or so.
== Smoke test
-Check at least if the server ist still starting with your changes ...
+Check at least if the server is still starting with your changes ...
== Pull request
-If you're confident of your work, the next step is to push your changes into your repository on github.
-To get your changes back into the TomEE repository you have to create a PR (pull request): on github go to your repository and select the branch where you have worked on.
+If you're confident of your work, the next step is to push your changes into your repository on GitHub.
+To get your changes back into the TomEE repository you have to create a PR (pull request): on GitHub go to your repository and select the branch where you have worked on.
Click on "New pull request" and then on "Create pull request".
== Request review
diff --git a/src/main/jbake/content/community/contributing/workflow.adoc b/src/main/jbake/content/community/contributing/workflow.adoc
index 6e73338..4c0dfc6 100644
--- a/src/main/jbake/content/community/contributing/workflow.adoc
+++ b/src/main/jbake/content/community/contributing/workflow.adoc
@@ -8,33 +8,31 @@
== JIRA ticket
-- create ticket in JIRA, if not already existing
-- if ticket already assigned to someone else => talk
-- assign ticket to contributor, if not already assigned +
+- Create a ticket in link:https://issues.apache.org/jira/browse/TOMEE[Jira], if it does not already exist.
+- If the ticket is already assigned to someone else => **talk** (e.g. via the mailing list)
+- Assign the ticket to the contributor, if it is not already assigned +
(xref:jira-ticket.adoc[more details])
-
-
== Process Task
-- fork repository
-- create branch in own repository (name = JIRA ticket id)
-- discuss on mailing list
-- work on code
-- document work in JIRA ticket +
+- Fork the repository on GitHub
+- Create a branch in your forked repository (name = JIRA ticket id)
+- Discuss on mailing list
+- Work on the code
+- Document work in JIRA ticket +
(xref:process-task.adoc[more details])
== Submit Changes
-- ensure code compiles
-- ensure tests passes
-- create PR (pull request)
-- ask for review on mailing list +
+- Ensure code compiles
+- Ensure tests passes
+- Create PR (pull request)
+- Ask for review on mailing list +
(xref:submit-changes.adoc[more details])
== Merge Changes (done by a committer)
-- review changes
-- merge code
-- change JIRA ticket status / close ticket +
+- Review changes
+- Merge code
+- Change JIRA ticket status / close ticket
== Cleanup
-- wait until PR is merged (ticket status change)
-- remove branch in own repository +
+- Wait until PR is merged (ticket status change)
+- Remove branch in own repository
diff --git a/src/main/jbake/content/community/sources.adoc b/src/main/jbake/content/community/sources.adoc
index 11cb2f3..1f04ba2 100755
--- a/src/main/jbake/content/community/sources.adoc
+++ b/src/main/jbake/content/community/sources.adoc
@@ -5,7 +5,7 @@
== GitHub
-TomEE is on GitHub at https://github.com/apache/tomee . The sources are synchronized by Apache on GitHub
+TomEE is on GitHub at link:https://github.com/apache/tomee[https://github.com/apache/tomee]. The sources are synchronized by Apache on GitHub
but Pull/Requests are integrated with Apache Infrastructure which means you can just submit us a patch as
you would do on any other GitHub project and Apache takes care of the rest of the process.
@@ -38,13 +38,13 @@ TomEE is a standard Maven project and to build it you just have to use the follo
mvn clean install
----
-TIP: you can need to tune your environment variable `MAVEN_OPTS`, a commonly use value is `-Xmx1536m -XX:PermSize=64m -XX:MaxPermSize=384m`
+TIP: You might need to tune your environment variable `MAVEN_OPTS`, a commonly used value is `-Xmx1536m -XX:PermSize=64m -XX:MaxPermSize=384m`
-NOTE: if you are interested in testing arquillian tests with all adapters of tomee you will need to activate the dedicated profile: `-Pall-adapters`.
+NOTE: If you are interested in testing arquillian tests with all adapters of tomee you will need to activate the dedicated profile: `-Pall-adapters`.
=== Fast build
-Here are some shortcut builds if you just want to create a specific artifact (note it skips tests but removing `-DskipTests` you will execute them):
+Here are some shortcut builds if you just want to create a specific artifact (note it skips tests but if you remove `-DskipTests` you will execute them):
- TomEE zip/tar.gz:
@@ -65,6 +65,7 @@ TomEE is using Jenkins CI for its continuous integration. You can access builds
TomEE uses Jira for issues, if you are looking for a problem or reporting one, use the following address:
-- Create a ticket on https://issues.apache.org/jira/browse/TOMEE
+- Create a ticket on link:https://issues.apache.org/jira/browse/TOMEE[https://issues.apache.org/jira/browse/TOMEE]
+- If you like to submit a patch: Open a PR in the GitHub mirror with the ticket number e.g. `TOMEE-1000 - Ticket Description`
-- Open a PR in the GitHub mirror with the ticket number e.g. `TOMEE-1000 - Ticket Description`
+You can also check the xref:contributing/workflow.adoc[contribution workflow] for further information.
diff --git a/src/main/jbake/content/security/security.adoc b/src/main/jbake/content/security/security.adoc
index c1c7b9b..61d01df 100755
--- a/src/main/jbake/content/security/security.adoc
+++ b/src/main/jbake/content/security/security.adoc
@@ -8,7 +8,7 @@
Please note that, except in rare circumstances, binary patches are not produced for individual vulnerabilities. To obtain the binary fix for a particular vulnerability you should upgrade to an Apache TomEE version where that vulnerability has been fixed.
-Source patches, usually in the form of references to SVN commits, may be provided in either in a vulnerability announcement and/or the vulnerability details listed on these pages. These source patches may be used by users wishing to build their own local version of TomEE with just that security patch rather than upgrade.
+Source patches, usually in the form of references to `git` commits, may be provided in either in a vulnerability announcement and/or the vulnerability details listed on these pages. These source patches may be used by users wishing to build their own local version of TomEE with just that security patch rather than upgrade.
The Apache Software Foundation takes a very active stance in eliminating security problems and denial of service attacks against Apache projects.
@@ -35,9 +35,9 @@ Note that all networked servers are subject to denial of service attacks, and we
Apache TomEE is built with the following components. Please see the security advisories information for each component for more information on the security vulnerabilities and issues that may affect that component.
-- Apache Tomcat: Tomcat security advisories
+- Apache Tomcat: link:https://tomcat.apache.org/security.html[Tomcat Security Advisories]
- Apache OpenJPA
-- Apache CXF: CXF Security Advisories
+- Apache CXF: link:https://cxf.apache.org/security-advisories.html[CXF Security Advisories]
- Apache OpenWebBeans
- Apache MyFaces
- Apache Bean Validation