Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix some formatting and links in contribution guide 

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
Lachlan Roberts 2021-06-23 15:45:39 +10:00
parent 1cd0093855
commit 7880917f64
4 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/jetty-documentation/src/main/asciidoc/contribution-guide/1-introduction.adoc
View File

@ -16,4 +16,4 @@
Eclipse Jetty is an open source project with a long pedigree of contribution.
Starting over 20 years ago, Jetty has had many committers over the years and owes much of its success to the people that make up the community.
There are many ways that you may contribute to Jetty and the goal of this guide is help you get there!
There are many ways that you may contribute to Jetty, and the goal of this guide is help you get there!

4
documentation/jetty-documentation/src/main/asciidoc/contribution-guide/3-source.adoc
View File

@ -55,7 +55,7 @@ Build related artifacts that release separately, common assembly descriptors, re
Files associated with the development of Jetty -- code styles, formatting, iplogs, etc.::
http://git.eclipse.org/c/jetty/org.eclipse.jetty.admin.git
[[t-contributing-build]]
[[cg-contributing-build]]
=== Maven Build
Eclipse Jetty uses http://maven.apache.org/[Apache Maven] for managing the project metadata and controlling the build.
@ -76,7 +76,7 @@ All relevant dependencies should be downloaded into your local repository automa
____
[NOTE]
Jetty has a great many test cases that run through the course of its build. Many of these tests spin up embedded instances of Jetty itself and it is not uncommon to see hundreds or more instances of Jetty start and stop during tests.
Jetty has a great many test cases that run through the course of its build. Many of these tests spin up embedded instances of Jetty itself, and it is not uncommon to see hundreds or more instances of Jetty start and stop during tests.
Periodically we find some test cases to be more time dependent than they should be and this results in intermittent test failures.
You can help track these down by opening an https://github.com/eclipse/jetty.project/issues[Issue].
____

6
documentation/jetty-documentation/src/main/asciidoc/contribution-guide/4-documentation.adoc
View File

@ -15,16 +15,16 @@
== Participate in the Documentation
Another wonderful way to help with Eclipse Jetty is to help contribute to our corpus of documentation.
We have taken every every to reduce the barriers to contributing to our documentation and many contributors find our documentation as a low key way to participate and learn the process.
We have made an effort to reduce the barriers to contributing to our documentation, and many contributors find our documentation as a low-key way to participate and learn the process.
[[cg-documentation-format]]
=== Source Control and Maven Build.
The Jetty documentation is a module within the overall Jetty project and is build as a part of the standard build process.
As such to checkout the documentation you can follow the link:#t-community-source[same process] as checking out Jetty itself.
As such to checkout the documentation you can follow the link:#cg-community-source[same process] as checking out Jetty itself.
As a part of the main Jetty project the documentation is build through the link:#t-community-build[same process] as Jetty.
As a part of the main Jetty project the documentation is build through the link:#cg-contributing-build[same process] as Jetty.
However, it is a more independent module and can be worked with much simpler by building strictly the jetty-documentation module.
[source, screen, subs="{sub-order}"]

5
documentation/jetty-documentation/src/main/asciidoc/old_docs/contributing/community.adoc
View File

@ -15,9 +15,8 @@
=== Community
Developers and users alike are welcome to engage the Jetty community.
We all have day jobs here so don't just ask questions and get frustrated if
no one answers right away. Stick around to hear an answer, one is likely coming
at some point!
We all have day jobs here so don't just ask questions and get frustrated if no one answers right away.
Stick around to hear an answer, one is likely coming at some point!
[[community-mailing-lists]]
==== Mailing Lists