Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWayne Beaton2018-01-03 18:59:23 +0000
committerWayne Beaton2018-01-03 18:59:23 +0000
commit3d5aeefc9bde1a3ad05fb397c4ee9b5d8abcb7b2 (patch)
tree5eef8dedc7fd60dec3f5f18c64b1d01203e38f29
parentc581dd0156f6ca7429e72d6cc04543cb88f57900 (diff)
downloadorg.eclipse.dash.handbook-3d5aeefc9bde1a3ad05fb397c4ee9b5d8abcb7b2.tar.gz
org.eclipse.dash.handbook-3d5aeefc9bde1a3ad05fb397c4ee9b5d8abcb7b2.tar.xz
org.eclipse.dash.handbook-3d5aeefc9bde1a3ad05fb397c4ee9b5d8abcb7b2.zip
[489588] Describe how to create a contribution questionnaire
This commit adds a section on "Committer Commands" to the PMI chapter. The new section also includes some advice on generating an IP Log and creating a new release record. https://bugs.eclipse.org/bugs/show_bug.cgi?id=489588 https://bugs.eclipse.org/bugs/show_bug.cgi?id=509114 https://bugs.eclipse.org/bugs/show_bug.cgi?id=508758
-rw-r--r--source/chapters/checklist.adoc5
-rw-r--r--source/chapters/ip.adoc35
-rw-r--r--source/chapters/pmi.adoc53
-rw-r--r--source/chapters/release.adoc18
-rw-r--r--source/chapters/resources.adoc4
-rw-r--r--source/icons/note.pngbin1762 -> 1582 bytes
-rw-r--r--source/icons/tip.pngbin0 -> 1910 bytes
7 files changed, 90 insertions, 25 deletions
diff --git a/source/chapters/checklist.adoc b/source/chapters/checklist.adoc
index c610a4b..37b5221 100644
--- a/source/chapters/checklist.adoc
+++ b/source/chapters/checklist.adoc
@@ -53,6 +53,11 @@ Release metadata is specified and maintained using the <<pmi, Project Management
* At least one release record describes a future release; and
* The release record includes a description that starts with a single paragraph that can serve as an _executive summary_.
+[TIP]
+====
+Use the <<pmi-commands-release, Create a new release>> command on a specific <<pmi-project-page, project page>> in the <<pmi,Project Management Interface (PMI)>> to create a new release record.
+====
+
[discrete]
=== Development Website
* Is hosted on Eclipse Foundation-provided infrastructure;
diff --git a/source/chapters/ip.adoc b/source/chapters/ip.adoc
index 352e2cd..7ed6fca 100644
--- a/source/chapters/ip.adoc
+++ b/source/chapters/ip.adoc
@@ -11,12 +11,14 @@ Code provenance tracking is critical (we need to know the source of all code tha
The IP Team will review your initial contribution to ensure that the code can distributed through {aForgeName} property. The IP Team will review the code to make sure that it hasn't been copied inappropriately, that licenses are being used correctly, and so forth. As part of this process, the IP Team will research the source of all code; depending on the size of the contribution, this can be a time-consuming process.
-[NOTE]
-====
A project cannot make a <<release, release>> until the due diligence on the IP contained in that release--including project code contributions and third party content--is complete.
-====
-Create a <<ip-cq,contribution questionnaire>> to submit the initial contribution for review by the IP Team.
+Create a <<ip-cq,contribution questionnaire>> (CQ) to submit the initial contribution for review by the IP Team.
+
+[TIP]
+====
+Use the <<pmi-commands-cq, Create a Contribution Questionnaire>> tool on a specific <<pmi-project-page, project page>> in the <<pmi,Project Management Interface (PMI)>> to create a CQ.
+====
The IP Team is not able to review the history of project code being moved to {aForgeName} project. The IP Team will review a snapshot of the project code and that snapshot, the initial contribution, must be the first commit in the {forgeName} repository. If your project uses an existing GitHub repository, the Webmaster team will help you obscure the history into a hidden branch.
@@ -27,7 +29,12 @@ Some contributions of code to maintained by the project (i.e. committed to a pro
All contributions of project code must be tracked in the project's <<ip-iplog,IP Log>>.
-Create a <<ip-cq,contribution questionnaire>> to submit a project code contribution for review by the IP Team.
+Create a <<ip-cq,contribution questionnaire>> to submit a project code contribution for review by the IP Team.
+
+[TIP]
+====
+Use the <<pmi-commands-cq, Create a Contribution Questionnaire>> tool on a specific <<pmi-project-page, project page>> in the <<pmi,Project Management Interface (PMI)>> to create a CQ.
+====
[[ip-third-party]]
=== Third Party Content
@@ -46,13 +53,15 @@ This list is not intended to be exhaustive.
The {ipThirdParty}[Guidelines for the Review of Third Party Dependencies] can help you determine how to classify your third party content.
-[NOTE]
-====
A project cannot make a <<release, release>> until the due diligence on the IP contained in that release--including project code contributions and third party content--is complete.
-====
Create a <<ip-cq,contribution questionnaire>> to submit third party content for review by the IP Team.
+[TIP]
+====
+Use the <<pmi-commands-cq, Create a Contribution Questionnaire>> tool on a specific <<pmi-project-page, project page>> in the <<pmi,Project Management Interface (PMI)>> to create a CQ.
+====
+
[[ip-ownership]]
=== Ownership
@@ -91,6 +100,11 @@ CQs for third party content are _version-specific_. That is, a separate CQ is re
CQs are not generally required for ongoing work done by project committers. Consult the IP Due Diligence Process document for more information.
+[TIP]
+====
+Use the <<pmi-commands-cq, Create a Contribution Questionnaire>> tool on a specific <<pmi-project-page, project page>> in the <<pmi,Project Management Interface (PMI)>> to create a CQ.
+====
+
[[ip-parallel-ip]]
==== Parallel IP
@@ -212,6 +226,11 @@ That contributions flagged in Bugzilla will only appear in the IP Log if the bug
The Third Party Software section of the log is populated from IPZilla. The IP Team will mark your contributions in such a way that they will appear in the log. If third party software is not appearing properly, contact the mailto:{ipTeamEmail}[EMO IP Team] to make corrections.
+[TIP]
+====
+Use the <<pmi-commands-iplog, Generate IP Log>> tool on a specific <<pmi-project-page, project page>> in the <<pmi,Project Management Interface (PMI)>> to generate and submit the IP Log for review.
+====
+
[[ip-faq]]
=== Frequently Asked Questions
diff --git a/source/chapters/pmi.adoc b/source/chapters/pmi.adoc
index a1ba2a7..24a7440 100644
--- a/source/chapters/pmi.adoc
+++ b/source/chapters/pmi.adoc
@@ -27,13 +27,56 @@ PMC members and the Eclipse Foundation staff also have the ability to make chang
[[pmi-viewing]]
=== Viewing
-The complete listing of all current {projectListUrl}[{forgeName} projects] provides one starting point for viewing projects. From here, you can link directly to a project information page. Navigation options are provided to help you move from one project to another.
+The complete listing of all current {projectListUrl}[{forgeName} projects] provides one starting point for viewing projects. From here, you can link directly to a <<pmi-project-page,project page>>. Navigation options are provided to help you move from one project to another.
+
+[[pmi-project-page]]
+=== Project Pages
+
+The PMI provides a website for every project based on the <<pmi-metadata,project metadata>>. This website includes an _overview_ page that includes the project's description, a _downloads_ page, a _developer_ page that includes links to <<source-repositories,source code repositories>>, and more. The website also includes links to project-related <<pmi-commands-and-tools,commands and tools>> when the user is logged in as a project committer.
+
+The URL for a project page takes the form `pass:c,a[{forgeUrl}/projects/<projectid>]` (e.g. `pass:c,a[{forgeUrl}/projects/technology.foo]`), where `pass:c,a[<projectid>]` is the qualified <<resources-identifers,identifier>> for the project.
[[pmi-commands-and-tools]]
=== Commands and Tools
Committers have access to several committer-specific commands and tools. The selection of commands available are context sensitive; only those commands that make sense for the logged in user are shown.
+[[pmi-commands-cq]]
+==== Create a Contribution Questionnaire
+
+Any project committer create <<ip-cq, Contribution Questionnaire>> (CQ). CQs are required to track some contributions of project code, as well as all uses of third-party content.
+
+To create a Contribution Questionnaire:
+
+1. Log in;
+2. Navigate to a project page;
+3. Click menu:Committer Tools[Intellectual Property > Create a Contribution Questionnaire]; and
+4. Follow the workflow.
+
+[[pmi-commands-iplog]]
+==== Submit a Project's IP Log for Review
+
+Any project committer generate the <<ip-iplog, Intellectual Property (IP) Log>> and submit it for review by the Eclipse IP Team. An IP Log review is required, for example, for all <<release-review, release reviews>> (release reviews are required for all major and minor releases).
+
+To generate an IP Log:
+
+1. Log in;
+2. Navigate to a project page;
+3. Click menu:Committer Tools[Intellectual Property > Generate IP Log]; and
+4. Follow the workflow.
+
+[[pmi-commands-release]]
+==== Create a New Release
+
+A project lead or committer can create a new <<release,release>> record. This opens a dialog requesting that a date and name be specified. Both of these values can be changed later.
+
+To generate an IP Log:
+
+1. Log in;
+2. Navigate to a project page;
+3. Click menu:Committer Tools[Releases > Create a new release]; and
+4. Follow the workflow.
+
[[pmi-editing]]
=== Editing Project Metadata
@@ -147,12 +190,12 @@ A review record, however, does not require a release association. Some reviews a
Each <<release,release>> has its own record in the database. Records are connected directly to a single specific project; a subset of release records associated with a project are displayed on the project page. An existing release can be edited in much the same was as a project. Any logged in project member (committer or project lead) can switch to the _Edit_ tab.
-[NOTE]
-====
Create a single record for each release. *Do not create release records for milestones.* Enter milestone information in the _Plan_ information for your release.
-====
-A project lead or committer can create a new release by clicking menu:Releases[Create a new release] in the _Committer Tools_ block on their project page. This opens a dialog requesting that a date and name be specified. Both of these values can be changed later.
+[TIP]
+====
+Use the <<pmi-commands-release, Create a new release>> command on a specific <<pmi-project-page, project page>> in the <<pmi,Project Management Interface (PMI)>> to create a new release record.
+====
[[pmi-release-description]]
==== Description
diff --git a/source/chapters/release.adoc b/source/chapters/release.adoc
index d3973ad..5c21b42 100644
--- a/source/chapters/release.adoc
+++ b/source/chapters/release.adoc
@@ -41,12 +41,10 @@ digraph {
A project plan is _required_ for each major and minor project release. The plan should lay out in broad terms what the goals are for the release. As plans are a valuable means for the community to get involved with your project, the plan should be created at the beginning of the release cycle. By establishing the plan early, you give prospective contributors help in determining how they can most usefully contribute, and adopters can prepare their own development schedule and themes. Plans can change during the release cycle.
-Use the <<pmi-releases, Project Management Infrastructure>> to create a new release record:
-
-* Navigate to the project page;
-* Ensure that you are logged in;
-* In the _Committer Tools_ block on the right side of the page, click menu:Releases[Create a new Release]; and
-* Use the form to provide information about the release.
+[TIP]
+====
+Use the <<pmi-commands-release, Create a new release>> command on a specific <<pmi-project-page, project page>> in the <<pmi,Project Management Interface (PMI)>> to create a new release record.
+====
At the start of the release cycle, your plan should minimally include a release number, date, and short description. Think of the description as an _elevator pitch_: how would you describe the release in a fifteen second elevator ride? All aspects of a plan can change during the release cycle (including the date). If you do change the plan, make sure that the change is communicated via your project's _dev_ list and other project channels.
@@ -98,16 +96,16 @@ Prepare the review documentation well in advance of the start of the review peri
The review materials must be approved by the PMC; send an email to
the PMC's mailing list asking for approval. The PMC will respond with feedback or a simple `pass:[+1]` indicating approval.
-[NOTE]
+[TIP]
====
-Click the handy menu:Committer Tools[Send Email to the PMC] link on the release record page to connect with the PMC.
+Click the handy menu:Committer Tools[Communication > Send Email to the PMC] link on the release record page to connect with the PMC.
====
Submit the IP Log for review by the IP Team. The IP Team must approve the IP Log before we can schedule the review, so submitting this early is important. The <<ip-iplog-generator,IP Log generator>> automatically collects information based on the information that the project team has provided to the IP Team through <<ip-cq,contribution questionnaires>> in IPZilla, commits in the project's source code repository, and other information in our databases. Carefully review the IP Log before submitting to the IP Team for their review.
-[NOTE]
+[TIP]
====
-Click the handy menu:Committer Tools[Generate IP Log] link on the release record page to open the IP Log generator.
+Use the <<pmi-commands-iplog, Generate IP Log>> tool on a specific <<pmi-project-page, project page>> in the <<pmi,Project Management Interface (PMI)>> to generate and submit the IP Log for review.
====
The information used to generate an IP Log should always be up-to-date (don't wait until the end of the release cycle to make it right).
diff --git a/source/chapters/resources.adoc b/source/chapters/resources.adoc
index a4d6690..127f9b1 100644
--- a/source/chapters/resources.adoc
+++ b/source/chapters/resources.adoc
@@ -154,7 +154,7 @@ The EMO strongly encourages the use of alternative communication channels for co
// Project-specific websites are only supported on the Eclipse forge.
ifeval::["{forgeName}"=="Eclipse"]
-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. PMI-based website URLs take the form of `pass:c,a[{forgeUrl}/projects/<projectid>]` (e.g. `pass:c,a[{forgeUrl}/projects/technology.foo]`).
+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 <<pmi-project-page,project website>>. PMI-based website URLs take the form of `pass:c,a[{forgeUrl}/projects/<projectid>]` (e.g. `pass:c,a[{forgeUrl}/projects/technology.foo]`).
Many project teams opt to create a custom main project website: if so-desired, a project may host a website on Eclipse Foundation-hosted servers. Project website URLs generally take the form `pass:c,a[{wwwUrl}/<shortname>]` (e.g. `pass:c,a[{wwwUrl}/foo]`). Custom project website content is maintained in Git repositories hosted on Eclipse Foundation infrastructure. A background job moves content from the Git repository to the website; content pushed to the repository will appear on the live website within five minutes.
@@ -164,7 +164,7 @@ If a project website has not already been created for your project, {websiteRequ
====
endif::[]
ifeval::["{forgeName}"!="Eclipse"]
-The <<pmi,Project Management Infrastructure>> (PMI) provides the main project website. Website URLs take the form of `pass:c,a[{forgeUrl}/projects/<projectid>]` (e.g. `pass:c,a[{forgeUrl}/projects/technology.foo]`).
+The <<pmi,Project Management Infrastructure>> (PMI) provides the main <<pmi-project-page,project website>>. Website URLs take the form of `pass:c,a[{forgeUrl}/projects/<projectid>]` (e.g. `pass:c,a[{forgeUrl}/projects/technology.foo]`).
endif::[]
Websites _not_ hosted by the Eclipse Foundation are considered <<trademark-external-community,community portals>> and are subject to the {trademarkGuidelinesUrl}[Guidelines for Eclipse Logo & Trademarks] (the Eclipse Foundation asserts ownership of all project name trademarks).
diff --git a/source/icons/note.png b/source/icons/note.png
index c84e8d3..263fbd5 100644
--- a/source/icons/note.png
+++ b/source/icons/note.png
Binary files differ
diff --git a/source/icons/tip.png b/source/icons/tip.png
new file mode 100644
index 0000000..2ac5747
--- /dev/null
+++ b/source/icons/tip.png
Binary files differ

Back to the top