org.eclipse.dash.handbook issueshttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues2020-11-25T19:33:15Zhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/21Move incubation branding requirements into handbook2020-11-25T19:33:15ZEclipse WebmasterMove incubation branding requirements into handbook## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#488421)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=488421)**
## Description
The handbook already includes much of the content in the "Project Phases" section. Thi...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#488421)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=488421)**
## Description
The handbook already includes much of the content in the "Project Phases" section. This should be pulled out into its own section.
https://www.eclipse.org/projects/handbook/#starting-project-phases
The wiki page should be scavenged for any other germane information and retired.
https://wiki.eclipse.org/Development_Resources/HOWTO/Conforming_Incubation_Brandinghttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/93Move incubation content into handbook2020-11-25T19:36:04ZEclipse WebmasterMove incubation content into handbook## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#528799)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=528799)**
## Description
Possibly related to [Bug 488421](https://bugs.eclipse.org/bugs/show_bug.cgi?id=488421)## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#528799)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=528799)**
## Description
Possibly related to [Bug 488421](https://bugs.eclipse.org/bugs/show_bug.cgi?id=488421)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/87Move more of the content regarding Contribution Questionnaires to the Handbook2020-11-25T19:35:52ZEclipse WebmasterMove more of the content regarding Contribution Questionnaires to the Handbook## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#526744)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=526744)**
## Description
There is some content here, including some board resolutions and a workflow diagram th...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#526744)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=526744)**
## Description
There is some content here, including some board resolutions and a workflow diagram that may fit in the handbook.
Redirect wiki page to handbook when done.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/19Move more of the Initial Contribution content into the handbook2020-11-25T19:33:11ZEclipse WebmasterMove more of the Initial Contribution content into the handbook## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#487246)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=487246)**
## Description
The wiki provides a little more detail on initial contributions that would be a valuab...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#487246)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=487246)**
## Description
The wiki provides a little more detail on initial contributions that would be a valuable addition to the handbook.
https://wiki.eclipse.org/Development_Resources/Initial_Contribution
Move this content and update the wiki.
### Depends on
* [Bug 494955](https://bugs.eclipse.org/bugs/show_bug.cgi?id=494955)
* [Bug 488237](https://bugs.eclipse.org/bugs/show_bug.cgi?id=488237)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/6Move Project Handbook source to Dash2020-11-25T19:32:38ZEclipse WebmasterMove Project Handbook source to Dash## Submitted by Wayne Beaton `@wbeaton`
Assigned to **Wayne Beaton `@wbeaton`**
**[Link to original bug (#475496)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=475496)**
## Description
I created the handbook source in the /projec...## Submitted by Wayne Beaton `@wbeaton`
Assigned to **Wayne Beaton `@wbeaton`**
**[Link to original bug (#475496)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=475496)**
## Description
I created the handbook source in the /projects directory directly. I did this primarily out of convenience so that I could focus on content. Now that I've completed the first version of the handbook, I'd like to extract the source from /projects and put it into its own dedicated repository. I'd like that repository to be connected into Gerrit.
I believe that moving it to Dash makes sense. I believe that the handbook reasonably qualifies as a tool for committers, so it is in-scope. The handbook source can be moved into its own repository and easily connected to Gerrit. Further, by having it in a project, we can request a Hudson instance to provide some CI functionality.
In these early days, it's been convenient to be able to push out regular minor updates, but now that we've reached a level of maturity, it makes sense to start treating the handbook like an actual project and schedule actual releases. i.e. conform to the development process.
Actual release content will be pushed into the /project directory (where it currently resides).
### Blocking
* [Bug 482414](https://bugs.eclipse.org/bugs/show_bug.cgi?id=482414)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/77Move proposal guidance to the handbook2020-11-25T19:35:30ZEclipse WebmasterMove proposal guidance to the handbook## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#521143)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=521143)**
## Description
This is currently captured in the wiki.
https://wiki.eclipse.org/Development_Resource...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#521143)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=521143)**
## Description
This is currently captured in the wiki.
https://wiki.eclipse.org/Development_Resources/HOWTO/Pre-Proposal_Phasehttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/63[nit] Use the term "third party content" instead of "third party library2021-03-24T17:25:49ZEclipse Webmaster[nit] Use the term "third party content" instead of "third party library## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#513468)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=513468)**
## Description## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#513468)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=513468)**
## Descriptionhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/107Only the year of first publication is required for copyright dates2020-11-25T19:36:35ZEclipse WebmasterOnly the year of first publication is required for copyright dates## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#533274)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=533274)**
## Description
The US Copyright Office recommends that copyright holders use copyright notices that i...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#533274)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=533274)**
## Description
The US Copyright Office recommends that copyright holders use copyright notices that include the year of first publication of the work.
While it is not wrong to include a range of dates, doing so is not necessary.
We need to update the handbook accordingly.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/10Oomph setup for dash.handbook2020-11-25T19:32:48ZEclipse WebmasterOomph setup for dash.handbook## Submitted by Jeremie Bresson
**[Link to original bug (#482962)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=482962)**
## Description
In my opinion each project at Eclipse should have an Oomph setup task, even for simple task.
...## Submitted by Jeremie Bresson
**[Link to original bug (#482962)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=482962)**
## Description
In my opinion each project at Eclipse should have an Oomph setup task, even for simple task.
In case of the Dash Handbook project, we need to:
* checkout the repo
* import the project: "Eclipse Project Handbook"
I also think that it would be nice to leverage other existing editors, even if they are not perfect (yet):
* AsciiDoc format support using Mylyn Docs [1] (Mylyn Docs Extras from the "Mylyn WikiText nightly" update site).
* Dot Graph format (from the GEF4 project) [2]: the editor is nice (syntax highlighting, error detection, CTRL+Space...), the preview view is limited (Graph capabilities from the Zest Framework), the outline view can be useful.
In addition:
1/ I think that it is OK to add the "org.eclipse.xtext.ui.shared.xtextNature" to the Eclipse Project Handbook. It is requested by the Dot SDK, but it will not affect users that do not use it.
2/ The "Sync with printable PDF using Graphwiz" feature in the Dot SDK produces PDF files in "/Eclipse Project Handbook/source/images/". I think an entry in gitignore is useful to prevent those files to be submitted.
I will submit a patch.
[1] https://wiki.eclipse.org/Mylyn/WikiText/AsciiDoc
[2] https://wiki.eclipse.org/GEF/GEF4/DOT
### See also
* https://git.eclipse.org/r/61211
* https://git.eclipse.org/c/dash/org.eclipse.dash.handbook.git/commit/?id=c70bbdebecabcaaa9bb4e581c3e247d1964665b3https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/103Paperwork section FAQ entry regarding employer engagement needs to be updated2020-11-25T19:36:27ZEclipse WebmasterPaperwork section FAQ entry regarding employer engagement needs to be updated## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#532371)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=532371)**
## Description
This question needs to be reworked. The employer is responsible for the MCA, but is no...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#532371)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=532371)**
## Description
This question needs to be reworked. The employer is responsible for the MCA, but is not directly responsible for completing ICA-related paperwork (i.e. the ECF is no longer required). Instead, the committer is responsible for completing the paperwork themselves with permission from their employer. So the tone should be more like "what if I cannot (for whatever reason) complete the paperwork?"
Should we maybe try to split this question and have one for MCA and one for ICA?
--
What happens if I cannot convince my employer to fill out the paperwork?
The Eclipse Board of Directors has taken a firm position that if you are employed then you must meet one of the scenarios described above. If you cannot convince your employer to fill out the necessary paperwork, then you cannot have write-access to project resources. This is the Board’s position even if you are working on Eclipse projects on your own time. We realize that this prevents some talented and desirable people from being able to commit to the projects but this is our IP risk reduction strategy.
--
### Blocking
* [Bug 530861](https://bugs.eclipse.org/bugs/show_bug.cgi?id=530861)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/111PMC Lead cannot subscribe to eclipse.org-planning-council mailing list2020-11-25T19:36:44ZEclipse WebmasterPMC Lead cannot subscribe to eclipse.org-planning-council mailing list## Submitted by Gunnar Wagenknecht `@gunnar`
**[Link to original bug (#534264)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=534264)**
## Description
(In reply to Wayne Beaton from [bug 528779](https://bugs.eclipse.org/bugs/show_bu...## Submitted by Gunnar Wagenknecht `@gunnar`
**[Link to original bug (#534264)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=534264)**
## Description
(In reply to Wayne Beaton from [bug 528779](https://bugs.eclipse.org/bugs/show_bug.cgi?id=528779) comment 5)
> The Planning Council mailing list is for Eclipse Planning Council members
> only. The way to engage the Planning Council is via your PMC. The PMC has a
> representative that will present your case.
Can the PMC Lead be subscribed to the Planning Council mailing list in order to have a backup for the PMC representative?
### Blocking
* [Bug 529388](https://bugs.eclipse.org/bugs/show_bug.cgi?id=529388)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/156PMC Members must be elected2021-09-24T20:24:27ZWayne BeatonPMC Members must be electedThe EDP states that:
> PMC leads are approved by the Board of Directors; PMC members are **elected** by the existing PMC leads and members, and approved by the EMO(ED).
In the handbook section on [PMC Member Elections](https://www.ecli...The EDP states that:
> PMC leads are approved by the Board of Directors; PMC members are **elected** by the existing PMC leads and members, and approved by the EMO(ED).
In the handbook section on [PMC Member Elections](https://www.eclipse.org/projects/handbook/#elections-pmc-member), we state:
> Some PMCs are set up to have a representative from each of the projects in the top-level project. Other PMCs are more exclusive and run an election similar to that of a project lead election.
The first sentence suggests that a project representatives can just be selected and we're done (that is, without an election). We need to make it clear that the manner by which members are selected must take the form of an election.
Further, we should describe the form of the election. We have no specific infrastructure configured for PMC Member elections, so they should be run in the PMC mailing list.Wayne BeatonWayne Beatonhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/1Project Criteria for becoming a Committer.2020-11-25T19:32:07ZEclipse WebmasterProject Criteria for becoming a Committer.## Submitted by David Carver
**[Link to original bug (#283880)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=283880)**
## Description
I have done a little research and currently there seems to be no documentation for any particular...## Submitted by David Carver
**[Link to original bug (#283880)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=283880)**
## Description
I have done a little research and currently there seems to be no documentation for any particular project on how somebody gets invited to be a committer. Are the rules different if they are a member company versus a contributer from the outside. What are the projects specific requirements.
Many times projects are saying they don't have time to do the work, because of lack of resources, but are they providing the necessary documentation on the criteria they expect for a somebody that wants to become a committer. Are they actively seeking and trying to recruite new committers.
It would help both existing projects, and new projects at eclipse if we could come up with some guidelines on how to document these requirements. I realize they will vary by project but having something for your user community can be a great help.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/117Project Handbook - reference to employer consent2020-11-25T19:36:57ZEclipse WebmasterProject Handbook - reference to employer consent## Submitted by Mike Milinkovich `@mmilinkovich`
**[Link to original bug (#537539)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=537539)**
## Description
The Project Handbook states:
"Committers must also gain their employers ...## Submitted by Mike Milinkovich `@mmilinkovich`
**[Link to original bug (#537539)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=537539)**
## Description
The Project Handbook states:
"Committers must also gain their employers consent to their participation in Eclipse Foundation open source projects."
This is, of course, true in general. But I just had an interaction with a member company representative that seemed to believe that this mandated the use of the employer consent form. Since we no longer require the ECF, perhaps we could re-word this sentence?https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/130Projects names may use a Working Group's brand2020-11-25T19:37:21ZEclipse WebmasterProjects names may use a Working Group's brand## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#549231)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=549231)**
## Description
The handbook states (in part):
--
The primary branding for any project name is fully-...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#549231)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=549231)**
## Description
The handbook states (in part):
--
The primary branding for any project name is fully-qualified formal name which includes the "Eclipse" prefix
--
The fully-qualified formal name may, with approval from a working group, use that working group's brand (e.g. "Jakarta Batch"). So... the formal name must have *an* Eclipse Foundation brand as a prefix.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/5Provide better help regarding the content of the committer election merit sta...2020-11-25T19:32:34ZEclipse WebmasterProvide better help regarding the content of the committer election merit statement## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#460734)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=460734)**
## Description
Committer elections require a statement of merit. We should provide more help for nomi...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#460734)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=460734)**
## Description
Committer elections require a statement of merit. We should provide more help for nominators to make sure that they get it right the first time.
Ideally, a nomination's statement of merit will list a handful of contributions (with links) made by the nominee. Rationalization that an individual has made significant contributions to the initial contribution in the past is also sufficient. e.g. "Bob has made significant contributions to the project; he created the such-and-such subsystem. He is joining the project to maintain and grow that functionality." (or something like that).
There is some discussion on [Bug 283880](https://bugs.eclipse.org/bugs/show_bug.cgi?id=283880). Also see [Bug 366435](https://bugs.eclipse.org/bugs/show_bug.cgi?id=366435) regarding automatic generation of merit statements.
### Depends on
* [Bug 440818](https://bugs.eclipse.org/bugs/show_bug.cgi?id=440818)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/43Provide branding guidance for Eclipse Marketplace entries2020-11-25T19:34:10ZEclipse WebmasterProvide branding guidance for Eclipse Marketplace entries## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#508078)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=508078)**
## Description
Project-produced Marketplace entries should follow certain rules and conventions.
As ...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#508078)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=508078)**
## Description
Project-produced Marketplace entries should follow certain rules and conventions.
As a general rule, project names should be avoided unless they are actually meaningful to the intended audience ("C/C++ Development Tools" is better than "CDT"; though that may be a bad example as CDT is pretty well known to the community).
The organization/provider must be "The Eclipse Foundation".
What else?
The existing link in the phrase "The Eclipse Foundation strongly encourages all projects to create an maintain and Eclipse Marketplace presence." should point to the new content.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/48Provide guidance for including vendor/company-specific links2021-09-24T20:25:42ZEclipse WebmasterProvide guidance for including vendor/company-specific links## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#508546)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=508546)**
## Description
Some project websites provide links to specific company websites (e.g. links to "profe...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#508546)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=508546)**
## Description
Some project websites provide links to specific company websites (e.g. links to "professional services"). These websites need to follow rules regarding level playing fields and vendor neutrality. We should provide some advice for getting this right.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/17Provide guidance regarding project logos in the handbook2020-11-25T19:33:07ZEclipse WebmasterProvide guidance regarding project logos in the handbook## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#485966)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=485966)**
## Description
The short version:
The project logo is intellectual property, so be sure that you're ...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#485966)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=485966)**
## Description
The short version:
The project logo is intellectual property, so be sure that you're not infringing on anybody's trademark or copyright.
Logos are not typically shipped as project code, so you don't generally need to get IP Team approval.
If the logo incorporates the Eclipse Logo, you'll need to get board approval.
### Depends on
* [Bug 498236](https://bugs.eclipse.org/bugs/show_bug.cgi?id=498236)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/49Provide guidance regarding the use of IP in milestone builds2020-11-25T19:34:27ZEclipse WebmasterProvide guidance regarding the use of IP in milestone builds## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#508554)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=508554)**
## Description
There is some confusion regarding the software that may be included in milestone build...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#508554)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=508554)**
## Description
There is some confusion regarding the software that may be included in milestone builds. We should include some guidance in the handbook.
Essentially, everything that goes into a build is subject to the IP Due Diligence Process. For those bits that are reviewed by the IP Team (via CQs), #checkin approval is required before something can be included in a nightly/integration/milestone/etc build. Full approval is required before the something can be included in a release.
Builds are discussed sporadically in the document. Perhaps we can grow the "Builds" section.
### Blocking
* [Bug 499707](https://bugs.eclipse.org/bugs/show_bug.cgi?id=499707)