Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWayne Beaton2016-10-24 18:04:46 -0400
committerWayne Beaton2016-10-24 18:04:46 -0400
commit1b75aea9dd409804d65f9e40829d93e1e60827eb (patch)
tree83f087e9706442918c1b09cb958d33f6a55a2b65
parentb85c38fd881d87def6f1229782f5def1c149df80 (diff)
downloadorg.eclipse.dash.handbook-1b75aea9dd409804d65f9e40829d93e1e60827eb.tar.gz
org.eclipse.dash.handbook-1b75aea9dd409804d65f9e40829d93e1e60827eb.tar.xz
org.eclipse.dash.handbook-1b75aea9dd409804d65f9e40829d93e1e60827eb.zip
Some general cleanup.
This commit is primarily concerned with making consistent use of header and other markup.
-rw-r--r--source/chapters/checklist.adoc28
-rw-r--r--source/chapters/community.adoc15
-rw-r--r--source/chapters/contact.adoc3
-rw-r--r--source/chapters/glossary.adoc3
-rw-r--r--source/chapters/ip.adoc47
-rw-r--r--source/chapters/links.adoc9
-rw-r--r--source/chapters/notices.adoc3
-rw-r--r--source/chapters/paperwork.adoc27
-rw-r--r--source/chapters/preamble.adoc8
-rw-r--r--source/chapters/resources.adoc63
-rw-r--r--source/chapters/starting.adoc12
-rw-r--r--source/chapters/trademarks.adoc6
-rw-r--r--source/config.adoc3
-rw-r--r--source/eclipse.adoc3
-rw-r--r--source/locationtech.adoc3
-rw-r--r--source/polarsys.adoc3
16 files changed, 100 insertions, 136 deletions
diff --git a/source/chapters/checklist.adoc b/source/chapters/checklist.adoc
index e827ba0..e04214c 100644
--- a/source/chapters/checklist.adoc
+++ b/source/chapters/checklist.adoc
@@ -16,32 +16,34 @@ in any Release or Graduation Review (specific examples are described below).
* All project code is managed in source code repositories provided by The Eclipse Foundation;
* All source files include a copyright and license header;
-* All project source code repositories include a https://wiki.eclipse.org/Architecture_Council/Contributor_Guide_Recommendation[CONTRIBUTING] file in the root;
+* All project source code repositories include a https://wiki.eclipse.org/Architecture_Council/Contributor_Guide_Recommendation[CONTRIBUTING] file
+(or equivalent) in the root;
* Naming Conventions followed:
-** e.g. +{namespace}.<short-name>.<component>[.*]+ for Java packages and OSGi Bundles;
+** e.g. `{namespace}.<short-name>.<component>[.*]` for Java packages and OSGi Bundles;
* Provider information is set to the project's formal name:
-** e.g. the 'Bundle-Vendor' entry set to "Eclipse Foo" in OSGi Bundles; or
-** e.g. the 'project' and 'organization' names are set to "{forgeName} Foo" in Maven `pom.xml` files;
-* Every module contains an +about.html+ file as required by the {legalDocumentationUrl}[guide to the legal documentation]; and
+** e.g. the `Bundle-Vendor` entry set to "Eclipse Foo" in OSGi Bundles; or
+** e.g. the `project` and `organization` names are set to "{forgeName} Foo" in Maven `pom.xml` files;
+* Every module contains an `about.html` file as required by the {legalDocumentationUrl}[guide to the legal documentation]; and
* Features names and descriptions are captured, are spelled correctly, use proper grammar, and contain content that is actually useful for the intended audience.
=== Downloads
-Most projects provide binary/compiled 'downloads' of their software, intended
+Most projects provide binary/compiled _downloads_ of their software, intended
for consumption by their various communities. If the project does not provide
downloads, then that should be stated on the project's website.
* All generated artifacts include only intellectual property that has been subject to the IP Due Diligence Process;
* All distributed third-party code has been approved by the IP Team;
* The project website and PMI page includes links for artifacts;
-* <<starting-project-phases,Incubation branding>> (if applicable) is included on distributed artifacts; and
-* Subject to limitations of specific technologies, the https://wiki.eclipse.org/Version_Numbering[Version numbering] rules are followed.
+* <<starting-project-phases,Incubation branding>> (if applicable) is included on distributed artifacts;
+* All download artifacts are (if technical feasible) {jarSigningUrl}[signed]; and
+* Subject to limitations of specific technologies, the {versionNumberingUrl}[Version numbering] rules are followed.
=== Project Metadata
Project metadata is specified and maintained using the <<pmi, Project Management Interface>>.
-* The formal name, e.g. '{forgeName} Foo(TM)', is used in the project title;
+* The formal name, e.g. _{forgeName} Foo(TM)_, is used in the project title;
* The formal name including appropriate marks is used in the first mention in the text of the project description, and scope;
* The project description starts with a single paragraph that can serve as an 'executive summary';
* Source code repository references are up-to-date; and
@@ -58,10 +60,10 @@ releases).
=== Development Website
* Is hosted on Eclipse Foundation-provided infrastructure;
-* Uses the formal name including appropriate marks, e.g. '{forgeName} Foo(TM)', on the page title, first mention in the text, and on all prominent references to the project;
+* Uses the formal name including appropriate marks, e.g. _{forgeName} Foo(TM)_, on the page title, first mention in the text, and on all prominent references to the project;
* Project incubation status (if applicable) is correctly noted;
* Includes a concise description of the project (with all necessary marks); and
-* The <<trademarks-website-footer,standard navigation>> links (e.g. {wwwUrl}) are included in the website footer.
+* The <<trademarks-website-footer,standard navigation>> links (e.g. `{wwwUrl}`) are included in the website footer.
=== Logos and graphics
* Project logo includes the trademark symbol; and
@@ -86,7 +88,7 @@ them must conform to the branding guidelines. If you discover a website that doe
conform to these guidelines (and it is not within your power to effect the changes yourself),
send a note to {emoEmail} to request assistance.
-* The formal name including appropriate marks, e.g. '{forgeName} Foo(TM)', is used on the page title, first mention in the text, and on all prominent references to the project;
+* The formal name including appropriate marks, e.g. _{forgeName} Foo(TM)_, is used on the page title, first mention in the text, and on all prominent references to the project;
* <<trademarks-external-attribution,Attributions>> are provided for all Eclipse Foundation marks;
* All references to {forgeName} open source projects use the formal name with appropriate marks;
* Trademark and registered trademark symbols are used appropriately;
@@ -99,6 +101,6 @@ send a note to {emoEmail} to request assistance.
All announcements regarding project milestones issued by the project must conform to the branding
guidelines.
-* The formal name including appropriate marks, e.g. '{forgeName} Foo(TM)', is used in the title, first mention in the text, and on all prominent references to the project;
+* The formal name including appropriate marks, e.g. _{forgeName} Foo(TM)_, is used in the title, first mention in the text, and on all prominent references to the project;
* <<trademarks-external-attribution,Attributions>> are provided for all Eclipse Foundation marks; and
* All references to {forgeName} open source projects use the formal name with appropriate marks.
diff --git a/source/chapters/community.adoc b/source/chapters/community.adoc
index d9be563..d85f42c 100644
--- a/source/chapters/community.adoc
+++ b/source/chapters/community.adoc
@@ -1,6 +1,5 @@
[[community]]
-Community
----------
+== Community
The Eclipse Development Process is mostly concerned with engaging in
activities that grow community involvement. An Eclipse project is
@@ -23,8 +22,7 @@ that you will draw additional contributions and other helpful input to
make your open source project a success.
[[community-barriers]]
-Lower the Barriers
-~~~~~~~~~~~~~~~~~~
+=== Lower the Barriers
One of the most critical aspects of running an open source project is
to grow user and adopter communities, invite contributions, and increase
@@ -57,8 +55,7 @@ Include support for the website, and regular updates to your project documentati
and tutorials as part of your project planning.
[[community-forums]]
-Forums
-~~~~~~
+=== Forums
It is through {forumsUrl}[forums] that adopters tend communicate with a project.
Very often, it is the only real support channel provided for those
@@ -100,8 +97,7 @@ The more welcome you make your community feel, the more likely it is
that your project will be successful.
[[community-bugzilla]]
-Bugzilla
-~~~~~~~~
+=== Bugzilla
When your community reports a problem, fix it as soon as possible. Be
sure to make a distinction between wish list items (I want more
@@ -124,8 +120,7 @@ understand why your code is implemented the way it is and give them a
pre-existing place (i.e. the bug) to pose further questions.
[[signs-of-success]]
-Signs of success
-~~~~~~~~~~~~~~~~
+=== Signs of success
Ultimately, everything above is about making it possible for a community
to find out about your project and provide opportunity to get involved.
diff --git a/source/chapters/contact.adoc b/source/chapters/contact.adoc
index 4895e17..ef1f80b 100644
--- a/source/chapters/contact.adoc
+++ b/source/chapters/contact.adoc
@@ -1,6 +1,5 @@
[[contact]]
-Getting Help
-------------
+=== Getting Help
If you have any questions, or are unsure of your responsibilities as a
project lead or committer, please contact your project mentors or
diff --git a/source/chapters/glossary.adoc b/source/chapters/glossary.adoc
index bd7577b..89db8ee 100644
--- a/source/chapters/glossary.adoc
+++ b/source/chapters/glossary.adoc
@@ -1,6 +1,5 @@
[[glossary]]
-Glossary
---------
+== Glossary
[glossary]
Architecture Council ::
diff --git a/source/chapters/ip.adoc b/source/chapters/ip.adoc
index cb1c5fd..47857ac 100644
--- a/source/chapters/ip.adoc
+++ b/source/chapters/ip.adoc
@@ -1,6 +1,5 @@
[[ip]]
-Intellectual Property
----------------------
+== Intellectual Property
{forgeName} projects are expected to take necessary precautions to mitigate
intellectual property (IP) risk to adopters. A company that integrates the code
@@ -13,8 +12,7 @@ All {forgeName} committers must be familiar with the {ipPolicyUrl}[Eclipse IP
Policy].
[[ip-initial-contribution]]
-Initial Contribution
-~~~~~~~~~~~~~~~~~~~~
+=== Initial Contribution
Code provenance tracking is critical (we need to know the source of all code
that ends up in our repositories). To that end, all new projects are required to
make an 'initial contribution' before *any* code is committed to a project's
@@ -41,8 +39,7 @@ that snapshot, the 'initial contribution', must be the first commit in the
Webmaster team will help you obscure the the history into a hidden branch.
[[ip-project-code]]
-Project Code Contributions
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Project Code Contributions
Some contributions of code to maintained by the project (i.e. committed to a
project source code repository and maintained by the project team) must be
@@ -58,8 +55,7 @@ Create a <<ip-cq,contribution questionnaire>> to submit a project code
contribution for review by the IP Team.
[[ip-third-party]]
-Third-Party Libraries
-~~~~~~~~~~~~~~~~~~~~~
+=== Third-Party Libraries
All third-party libraries required by project code will have to be checked
and approved by the IP Team.
@@ -90,16 +86,14 @@ Create a <<ip-cq,contribution questionnaire>> to submit a third-party
library for review by the IP Team.
[[ip-ownership]]
-Ownership
-~~~~~~~~~
+=== Ownership
The author of a contribution (or their employer) retains ownership of the
intellectual property contained in the contribution. As part of the contribution
process, the contributor licenses their contribution under the project license.
[[ip-copyright-headers]]
-Copyright and License Headers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Copyright and License Headers
All source files must include a file header that describes the copyright and
license terms of the software.
@@ -133,8 +127,7 @@ be listed as the copyright owner.
For more information please see the {copyrightUrl}[Default Eclipse Foundation Copyright and License Notice].
[[ip-licensing]]
-Licensing
-~~~~~~~~~
+=== Licensing
{forgeName} top level projects define the standard licensing for their
projectsd. If your project has non standard licensing requirements,
@@ -143,8 +136,8 @@ to request their approval. The presentation need only briefly describe
the project and why special licensing considerations are necessary.
[[ip-ipzilla]]
-IPZilla
-~~~~~~~
+=== IPZilla
+
{ipzillaUrl}[IPZilla] is a modified instance of Bugzilla that tracks the progress
of the intellectual property due diligence review and approval process.
It is the main interaction point between committers and the
@@ -155,8 +148,7 @@ NOTE: IPZilla is accessible only by committers, Eclipse Foundation
member company representatives, and other specifically-designated individuals.
[[ip-cq]]
-Contribution Questionnaires
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Contribution Questionnaires
A Contribution Questionnaires (CQ) is the main interface
between {forgeName} committers and the IP Team.
@@ -184,8 +176,7 @@ committers. Consult the IP Due Diligence Process document for
more information.
[[ip-parallel-ip]]
-Parallel IP
-^^^^^^^^^^^
+==== Parallel IP
The 'Parallel IP Process' allows {forgeName} projects to make use of
project code contributions and third-party libraries before they
@@ -217,8 +208,7 @@ to check-in the code start working on it.
All IP must be fully approved before it is included in a release.
[[ip-piggyback]]
-Piggyback CQs
-^^^^^^^^^^^^^
+==== Piggyback CQs
Many third party libraries have already been approved for use in {forgeName} projects.
Many of those are immediately available via the http://www.eclipse.org/orbit[Orbit Project].
@@ -230,8 +220,7 @@ In this case, a 'piggyback CQ' can be created on top of an existing CQ. Piggybac
are generally approved very quickly as the due diligence work has already been completed.
[[ip-cq-workflow]]
-CQ Workflow
-^^^^^^^^^^^
+==== CQ Workflow
The workflow for creating a CQ for a third-party library starts with a search of existing
CQs. If an existing CQ can be found that is concerned with the same library and version,
@@ -256,8 +245,7 @@ to process a CQ depends on numerous factors including the size of the queue, and
nature and size of the contribution.
[[ip-iplog]]
-IP Logs
-~~~~~~~
+=== IP Logs
An IP Log is a record of the intellectual property contributions to a project.
This includes such as a list of all committers, past and present, that have
@@ -279,8 +267,8 @@ Specifically, the log tracks:
* Contributions from outside the project (i.e. non-committers)
[[ip-iplog-generator]]
-IP Log Generator
-^^^^^^^^^^^^^^^^
+==== IP Log Generator
+
The Automated IP Log Tool automatically generates an IP Log using information
that is available to the Eclipse Foundation. The list of committers, for
example is generated using information provided by the Dash project which itself
@@ -379,8 +367,7 @@ the log. If third party software is not appearing properly, contact the
mailto:{ipTeamEmail}[EMO IP Team] to make corrections.
[[ip-faq]]
-Frequently Asked Questions
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Frequently Asked Questions
[qanda]
Do we really need to do this? ::
diff --git a/source/chapters/links.adoc b/source/chapters/links.adoc
index c097a9a..b7ce232 100644
--- a/source/chapters/links.adoc
+++ b/source/chapters/links.adoc
@@ -1,6 +1,5 @@
[[links]]
-Links
------
+== Links
Here are some other links that should help you with the process:
@@ -13,10 +12,10 @@ Eclipse Foundation Forges;
http://eclipse.org/proposals/mpc/[Marketplace Client]
* link:Architecture Council[Architecture Council] - The role of the
Architecture Council in a new project;
-* link:Development Resources/HOWTO/Creation Reviews[ Creation Reviews] -
+* link:Development Resources/HOWTO/Creation Reviews[Creation Reviews] -
Scheduling the proposal's creation review; and
-* link:Development Resources/HOWTO/Incubation Phase[ Incubation Phase] -
+* link:Development Resources/HOWTO/Incubation Phase[Incubation Phase] -
After the project has been created.
-* link:Community_Development_for_Eclipse_Projects[ Community
+* link:Community_Development_for_Eclipse_Projects[Community
Development] - Communities don't develop themselves! Some of the things
you need to think about.
diff --git a/source/chapters/notices.adoc b/source/chapters/notices.adoc
index 1f38965..33066f2 100644
--- a/source/chapters/notices.adoc
+++ b/source/chapters/notices.adoc
@@ -1,5 +1,4 @@
[[notices]]
-Notices
--------
+== Notices
Copyright (C) 2015, 2016 Eclipse Foundation, Inc., Made available under the Eclipse Public License v 1.0 \ No newline at end of file
diff --git a/source/chapters/paperwork.adoc b/source/chapters/paperwork.adoc
index 502aa78..424d47a 100644
--- a/source/chapters/paperwork.adoc
+++ b/source/chapters/paperwork.adoc
@@ -1,6 +1,5 @@
[[paperwork]]
-Committer Paperwork
--------------------
+== Committer Paperwork
The Eclipse Foundation needs to ensure that all committers with write
access to the code, web site, and issue tracking system understand their role in
@@ -18,8 +17,7 @@ All committers must complete the 'Committer Questionnaire' and provide documenta
as described below.
[[paperwork-questionnaire]]
-Committer Questionnaire
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Committer Questionnaire
The {committerQuestionnaireUrl}[Committer Questionnaire] is an online form that
must be completed by all new committers. This form offers two separate paths:
@@ -34,8 +32,7 @@ Only member companies that have provided a signed Member Committer Agreement
will be listed as member companies in the Committer Questionnaire.
[[paperwork-documents]]
-Documents
-~~~~~~~~~
+=== Documents
The exact nature of the documentation required is dependent on your
employments status.
@@ -99,8 +96,7 @@ Documents must be printed, signed and then returned either by fax
to {emoRecordsEmail}.
[[paperwork-mca]]
-Member Committer Agreement
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Member Committer Agreement
The {mcaUrl}[Member Committer Agreement] (MCA) is used by member companies to
cover all of their employees who participate in Eclipse Foundation projects
@@ -126,8 +122,7 @@ MCA, then you'll have to complete an Individual Committer Agreement and
Eclipse Committer Employer Consent Form.
[[paperwork-ica]]
-Individual Committer Agreement
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Individual Committer Agreement
The {icaUrl}[Individual Committer Agreement] (ICA) is used by committers
who are not covered by an Member Committer Agreement.
@@ -144,8 +139,7 @@ or self-employed, then you also need an 'Eclipse Committer Employer'
Consent Form.
[[paperwork-ececf]]
-Eclipse Committer Employer Consent Form
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Eclipse Committer Employer Consent Form
Committers covered by an Individual Committer Agreement must document
the consent of their employer when participating in Eclipse Foundation
@@ -167,8 +161,7 @@ your principal business customer to sign and submit the
Eclipse Committer Employer Consent Form on your behalf.
[[paperwork-existing]]
-Existing Committer
-~~~~~~~~~~~~~~~~~~
+==== Existing Committer
If you are already a committer on an existing Eclipse Foundation project then
additional paperwork may or may not be needed. The EMO IP Team will ask for
@@ -183,8 +176,7 @@ the new project, then the candidate must provide the documents as described
above.
[[paperwork-not-employed]]
-Not Employed or Student
-~~~~~~~~~~~~~~~~~~~~~~~
+==== Not Employed or Student
If you are not employed or are a student, send a note to {emoRecordsEmail}
explaining your not employed or student status.
@@ -195,8 +187,7 @@ need to be noted.
[[paperwork-faq]]
-Frequently Asked Questions
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Frequently Asked Questions
[qanda]
What happens if I do not fill out the paperwork?::
diff --git a/source/chapters/preamble.adoc b/source/chapters/preamble.adoc
index ba754af..1ccc347 100644
--- a/source/chapters/preamble.adoc
+++ b/source/chapters/preamble.adoc
@@ -1,6 +1,6 @@
[[preamble]]
-Overview
---------
+== Overview
+
This document provides you with the information that you need to
create a new {forgeName} open source project or become a committer
on an existing one.
@@ -26,8 +26,8 @@ This document will elaborate on some key points of the Eclipse Development
Process.
[[preamble-principles]]
-Principles
-~~~~~~~~~~
+=== Principles
+
Four basic principles lie at the heart of the Eclipse Development Process:
* Transparency;
diff --git a/source/chapters/resources.adoc b/source/chapters/resources.adoc
index d85e498..1fed8a1 100644
--- a/source/chapters/resources.adoc
+++ b/source/chapters/resources.adoc
@@ -1,6 +1,6 @@
[[project-resources-and-services]]
-Project Resources and Services
-------------------------------
+== Project Resources and Services
+
Open source projects at the Eclipse Foundation are required to make use
of certain Eclipse Foundation services:
@@ -17,8 +17,8 @@ provided to the project by the Eclipse Foundation; and
* Projects must keep their <<pmi-metadata, Project Metadata>> up-to-date.
[[resources-source]]
-Source Code Management
-~~~~~~~~~~~~~~~~~~~~~~
+=== Source Code Management
+
Your project must maintain source code in the repositories assigned to the
project by the Eclipse Foundation. These official repositories must be
the exclusive source of all project code delivered via the project's assigned
@@ -30,8 +30,8 @@ form, so all ongoing development must be regularly pushed to these canonical
repositories.
[[resources-eca]]
-Eclipse Contributor Agreement (ECA)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+=== Eclipse Contributor Agreement (ECA)
+
The Eclipse Foundation has implemented the {ecaUrl}[Eclipse Contributor Agreements] (ECA)
to improve <<ip,intellectual property>> (IP) management and workflow. All
contributors, who are not committers on the {forgeName} project, must sign the ECA.
@@ -40,8 +40,8 @@ You do *not* require an ECA to contribute to a project on which you have committ
status.
[[resources-commit]]
-Git Commit Records
-^^^^^^^^^^^^^^^^^^
+=== Git Commit Records
+
Git commit records are required to take a specific form. The credentials
of the actual author must be used to populate the +Author+ field. The email
address used must match the email address that the Eclipse Foundation has
@@ -101,8 +101,8 @@ account and must have a signed <<resources-eca,Eclipse Contributor Agreement>> (
on file.
[[resources-git]]
-Git
-^^^
+=== Git
+
Those projects that want to use Git on the {forgeName} forge, are assigned a
directory in which they may create as many Git repositories as required.
{gitRequestUrl}[Open a bug] to request that the Webmaster create a new Git
@@ -127,8 +127,8 @@ that includes commits that do not conform to the required form will be rejected.
You can {gitUrl}[browse {forgeName} repositories] directly on the Git server.
[[resources-gerrit]]
-Gerrit Code Review
-^^^^^^^^^^^^^^^^^^
+=== Gerrit Code Review
+
https://www.gerritcodereview.com/[Gerrit] provides web based code review and
repository management for the Git version control system. Many projects use
Gerrit to reduce barriers and encourage contribution to the project.
@@ -147,8 +147,8 @@ You can {gerritUrl}[browse {forgeName} repositories] directly on the Gerrit
server.
[[resources-github]]
-GitHub
-^^^^^^
+=== GitHub
+
Projects may opt to move some or all of their canonical source code repositories to the
{gitHubUrl}[{forgeName} organization] on GitHub. Both GitHub Issues and Wiki may also
be used.
@@ -184,8 +184,8 @@ NOTE: The Eclipse Webmaster creates and maintains a mirror of all GitHub-hosted
repositories on Eclipse Foundation hardware.
[[resources-issues]]
-Issue Trackers
-~~~~~~~~~~~~~~
+=== Issue Trackers
+
{forgeName} projects must use an Eclipse Foundation-provided
issue tracker. Project teams may opt to use either the {bugzillaUrl}[{forgeName} Bugzilla]
instance or--for projects that use <<resources-github,GitHub>>--GitHub Issues instances associated
@@ -199,14 +199,14 @@ To request _GitHub Issues_ access for your project, a bug against
with a request for their approval.
[[resources-libraries]]
-Third-party Libraries
-~~~~~~~~~~~~~~~~~~~~~
+=== Third-party Libraries
+
{forgeName} projects must register all of their <<ip-third-party,third-party library>> use with the
IP Team.
[[resources-forums]]
-Forums and Outbound Communication
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Forums and Outbound Communication
+
All projects are assigned a {forumsUrl}[user forum] as a point of contact between
the user and adopter communities, and the project developers.
@@ -215,8 +215,8 @@ connecting with the community: your project team knows your community and how
to best connect with them.
[[resources-website]]
-Project Websites
-~~~~~~~~~~~~~~~~
+=== Project Websites
+
Project websites are an excellent way to connect your project with
your community. Many projects opt to use the <<pmi,Project Management Infrastructure>>
(PMI) as their project website,
@@ -235,25 +235,25 @@ Logo & Trademarks] (the Eclipse Foundation asserts ownership of the
project name trademark).
[[resources-builds]]
-Builds
-~~~~~~
+=== Builds
+
Use of Eclipse Foundation-provided and hosted build services, the so-called
-{cbiUrl}[Common Build Infrastructure] (CBI) is strongly recommended, but n
-ot strictly required.
+{cbiUrl}[Common Build Infrastructure] (CBI) is strongly recommended, but not
+strictly required.
Whether or not your project chooses to make use of provided build resources, it must
be possible for members of the community to build project artifacts from
source code with reasonable effort.
[[resources-signing]]
-Signed Artifacts
-^^^^^^^^^^^^^^^^
+==== Signed Artifacts
+
Where technically sensible, all downloadable artifacts should
be {jarSigningUrl}[signed] by an Eclipse Foundation-provided certificate.
[[resources-downloads]]
-Downloads
-~~~~~~~~~
+==== Downloads
+
Project artifacts (e.g. downloads) can be distributed via third-party
services (e.g. Maven Central), but the Eclipse Foundation-provided
infrastructure must be considered the primary source of project
@@ -263,8 +263,7 @@ Project committers can {downloadsUrl}[upload project artifacts] to the project's
directory on the download server.
[[resources-faq]]
-Frequently Asked Questions
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Frequently Asked Questions
[qanda]
Can a project use the _gh-pages_ support from Github to host at _<project>.github.io_?::
diff --git a/source/chapters/starting.adoc b/source/chapters/starting.adoc
index 75ce7a1..2a8071b 100644
--- a/source/chapters/starting.adoc
+++ b/source/chapters/starting.adoc
@@ -1,6 +1,5 @@
[[starting]]
-Starting an Open Source Project at {forgeName}
-----------------------------------------------
+== Starting an Open Source Project at {forgeName}
Before getting started, it's important to know what is required
of {aForgeName} project. The Eclipse Foundation will take ownership
@@ -152,8 +151,7 @@ instructions; please don't send any paperwork in until after you receive
those instructions.
[[starting-after-provisioning]]
-After Provisioning
-~~~~~~~~~~~~~~~~~~
+=== After Provisioning
The Webmaster will send a note announcing the completion of the provisioning
process. Before you commit any code into your project repository, you must
@@ -203,8 +201,7 @@ indicate check-in permission by adding the +checkin+ keyword and final
approval by setting the state of the CQ to +approved+.
[[starting-project-phases]]
-Project Phases
-~~~~~~~~~~~~~~
+=== Project Phases
All new projects start in the 'incubation phase' (a project in the
incubation phase is said to be 'incubating'). The classification of
@@ -256,8 +253,7 @@ A mature project is one that:
* Actively nurtures the three communities: developers, adopters, and users.
[[starting-faq]]
-Frequently Asked Questions
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Frequently Asked Questions
[qanda]
How do I find Architecture Council mentors? ::
diff --git a/source/chapters/trademarks.adoc b/source/chapters/trademarks.adoc
index 2cb55c2..544dac4 100644
--- a/source/chapters/trademarks.adoc
+++ b/source/chapters/trademarks.adoc
@@ -350,10 +350,10 @@ Where applicable and supported by the programming languages and style
used by the project, code namespaces must include the project’s short
name.
-In Java, for example, package names must start with +{namespace}+ and use
+In Java, for example, package names must start with `{namespace}` and use
their short name in the third-segment  (i.e. follow the pattern
-+{namespace}.<short-name>.<component>+), e.g. +{namespace}.foo.core+,
-+{namespace}.foo.ui+, and +{namespace}.foo.connector+. Component
+`{namespace}.<short-name>.<component>`), e.g. `{namespace}.foo.core`,
+`{namespace}.foo.ui`, and `{namespace}.foo.connector`. Component
names are left to the discretion of the project team.
The project team must petition the Planning Council via their PMC to
diff --git a/source/config.adoc b/source/config.adoc
index 91f60e0..e0b88aa 100644
--- a/source/config.adoc
+++ b/source/config.adoc
@@ -32,8 +32,9 @@
:dcoUrl: https://www.eclipse.org/legal/DCO.php
:incubationListUrl: https://dev.eclipse.org/mailman/listinfo/incubation
-:jarSigningUrl: https://wiki.eclipse.org/JAR_Signing
+:jarSigningUrl: https://wiki.eclipse.org/IT_Infrastructure_Doc#Sign_my_plugins.2FZIP_files.3F
:downloadsUrl: https://wiki.eclipse.org/IT_Infrastructure_Doc#Downloads
+:versionNumberingUrl: https://wiki.eclipse.org/Version_Numbering
:bugzillaGitHubUrl: https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=GitHub
diff --git a/source/eclipse.adoc b/source/eclipse.adoc
index ccea925..41bf689 100644
--- a/source/eclipse.adoc
+++ b/source/eclipse.adoc
@@ -16,8 +16,7 @@ include::config.adoc[]
:pmiSampleImage: images/pmi-egit25.png
-Eclipse Project Handbook
-========================
+= Eclipse Project Handbook
include::chapters/notices.adoc[]
diff --git a/source/locationtech.adoc b/source/locationtech.adoc
index e3eefe3..c8e3159 100644
--- a/source/locationtech.adoc
+++ b/source/locationtech.adoc
@@ -14,8 +14,7 @@ include::config.adoc[]
:forumsUrl: http://www.locationtech.org/forums
:mailingListsUrl: http://www.locationtech.org/mail/
-LocationTech Project Handbook
-=============================
+= LocationTech Project Handbook
include::chapters/notices.adoc[]
diff --git a/source/polarsys.adoc b/source/polarsys.adoc
index d3e4afe..a1167bd 100644
--- a/source/polarsys.adoc
+++ b/source/polarsys.adoc
@@ -14,8 +14,7 @@ include::config.adoc[]
:forumsUrl: http://www.polarsys.org/forums
:mailingListsUrl: http://www.polarsys.org/mail/
-PolarSys Project Handbook
-=========================
+= PolarSys Project Handbook
include::chapters/notices.adoc[]

Back to the top