org.eclipse.dash.handbook issueshttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues2020-11-25T19:37:07Zhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/122Update the Bylaws link2020-11-25T19:37:07ZEclipse WebmasterUpdate the Bylaws link## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#538667)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=538667)**
## Description
Once we've confirmed the new permanent address for the Bylaws, let's update the handbo...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#538667)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=538667)**
## Description
Once we've confirmed the new permanent address for the Bylaws, let's update the handbook.
### Depends on
* [Bug 499704](https://bugs.eclipse.org/bugs/show_bug.cgi?id=499704)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/121Include instructions for building a Hugo-based project website in the handbook2020-11-25T19:37:05ZEclipse WebmasterInclude instructions for building a Hugo-based project website in the handbook## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#538665)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=538665)**
## Description
Cribbed from a thread on the incubation mailing list:
--
I recommend using our eclips...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#538665)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=538665)**
## Description
Cribbed from a thread on the incubation mailing list:
--
I recommend using our eclipsefdn-hugo-solstice-theme to get started since it includes all the Eclipse Foundation project website requirements such as our cookie consent banner and our google tag manager ID.
Hugo is very flexible content management system. For example, iot.eclipse.org is now built using our eclipsefdn-hugo-solstice-theme without the usual EF look and feel.
If you are looking for example on how to setup your project, I would recommend taking a look at the following website git repos:
jakarta.ee https://github.com/jakartaee/jakartaee.github.io
iot.eclipse.org https://github.com/EclipseFdn/iot.eclipse.org
Our Hugo projects are using NPM to manage dependencies, such as our theme:
https://www.npmjs.com/package/eclipsefdn-hugo-solstice-theme
You can install the latest version of the theme via the following command:
npm install eclipsefdn-hugo-solstice-theme --save
The source code of our theme includes a website example via the exampleSite folder:
https://github.com/EclipseFdn/hugo-solstice-theme/tree/master/exampleSite
If you chose to install our theme using NPM, you will need to update the themeDir variable in your config.toml file to let Hugo know where to find your theme:
themesDir = "node_modules/"
--https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/120Add the Eclipse Foundations project server policy to the handbook2024-01-15T20:53:51ZEclipse WebmasterAdd the Eclipse Foundations project server policy to the handbook## Submitted by Eclipse Webmaster `@webmaster`
**[Link to original bug (#538607)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=538607)**
## Description
We've created the following policy for virtual machines provided by the Eclipse...## Submitted by Eclipse Webmaster `@webmaster`
**[Link to original bug (#538607)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=538607)**
## Description
We've created the following policy for virtual machines provided by the Eclipse Foundation.
`<----- Begin Policy ---->`
Project Server Policy
By operating a virtual server hosted either directly by the Eclipse Foundation or provided via the Eclipse Foundation’s funding in support of an Eclipse Foundation open source project to which you are a committer, you agree to the following:
1)To respond within 30 days to written requests eclipse.org-gdpr@eclipse.org to delete accounts or make user data available to the specific user in question. Server maintainers must subscribe to this list.
2)To collect only as much information is required to process the user’s request and to securely dispose of it when no longer required.
3)To make the contents of the server available for auditing should the need arise, and to provide support as required in order to carry out the audit process.
4)To take reasonable security precautions to prevent unauthorized access, and to notify the Eclipse Foundation (via privacy@eclipse.org) immediately if you suspect a security breach of any kind. Be sure to include the nature and scope of the suspected breach.
5)To ensure all web pages related to operation of the server use either the standard Eclipse.org footer template, or a footer that prominently contains a copyright notice, and the following set of links:
1) Main Eclipse Foundation website (http://www.eclipse.org)
2) Privacy policy (http://www.eclipse.org/legal/privacy.php)
3) Website terms of use (http://www.eclipse.org/legal/termsofuse.php)
4) Copyright agent (http://www.eclipse.org/legal/copyright.php)
5) Legal (http://www.eclipse.org/legal)
6)To ensure explicit consent has been given by the user before you can start using cookies. This requirement also includes cookies used by 3rd party services such as, but not limited to: Google Tag Manager, and social media widgets.
7)To ensure webpages related to the services being offered are fully compliant with the GDPR regulations
8)To not collect or track user activity on Eclipse Foundation-owned domains.
9)Google Analytics codes that do not belong the the Eclipse Foundation are prohibited
Failure to comply with this Policy may result in the server or funding in question being terminated without notice.
`<-------- End Policy ------>`
### Blocking
* [Bug 534384](https://bugs.eclipse.org/bugs/show_bug.cgi?id=534384)
### See also
* https://bugs.eclipse.org/bugs/show_bug.cgi?id=552136https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/119Add a section that describes how to be a member of the Architecture Council2020-11-25T19:37:02ZEclipse WebmasterAdd a section that describes how to be a member of the Architecture Council## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#538428)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=538428)**
## Description
It would be handy to have some content to help Architecture Council members understand...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#538428)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=538428)**
## Description
It would be handy to have some content to help Architecture Council members understand their role.
e.g.
What does a project mentor do?
How do I become a project mentor?https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/118Add discussion regarding trademarks to the "Starting an Open Source Project a...2024-01-15T20:35:32ZEclipse WebmasterAdd discussion regarding trademarks to the "Starting an Open Source Project at Eclipse Foundation" section## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#537997)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=537997)**
## Description
We do have some discussion regarding trademarks in the document (e.g. [1]) and the "St...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#537997)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=537997)**
## Description
We do have some discussion regarding trademarks in the document (e.g. [1]) and the "Starting an Open..." section [2] does touch on the subject, but more detail will be valuable.
We should, for example, describe the trademark review and transfer process, offer some specific guidance regarding how to select a name, and ensure that the reader is aware that they will need to sign related domain names to the Eclipse Foundation.
It might be valuable to talk about expectations regarding technical namespaces (e.g. that projects should use "org.eclipse.*" for their Java namespace when technically feasible).
[1] https://www.eclipse.org/projects/handbook/#trademarks
[2] https://www.eclipse.org/projects/handbook/#startinghttps://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/116Provide help for getting content into Maven Central2020-11-25T19:36:54ZEclipse WebmasterProvide help for getting content into Maven Central## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#536962)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=536962)**
## Description
We need to provide help (even if it is just pointers) for project teams who need to pu...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#536962)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=536962)**
## Description
We need to provide help (even if it is just pointers) for project teams who need to publish their content to Maven Central.
Mikael, do we have content (perhaps a wiki page) that describes how we accomplish this via CBI?https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/115Move (at least some) content from the Webmaster FAQ to the handbook2020-11-25T19:36:52ZEclipse WebmasterMove (at least some) content from the Webmaster FAQ to the handbook## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#536715)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=536715)**
## Description
The "how tos" regarding things like tools for creating new Bugzilla milestones, versio...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#536715)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=536715)**
## Description
The "how tos" regarding things like tools for creating new Bugzilla milestones, versions, and components are a good fit for the handbook.
Note that adding this content to the handbook will make it harder for the Webmaster to update them.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/114Reinforce vendor neutrality requirement/value regarding project web pages and...2020-11-25T19:36:51ZEclipse WebmasterReinforce vendor neutrality requirement/value regarding project web pages and other content## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#536689)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=536689)**
## Description
Revisit the language that we use around vendor neutrality on project web pages in part...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#536689)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=536689)**
## Description
Revisit the language that we use around vendor neutrality on project web pages in particular, and project resources in general.
e.g. make explicit that level playing field rules apply with regard to providing links to vendor specific content (i.e. another vendor, playing by the same rules, can also have equivalent links to their content).
e.g. possibly add an FAQ entry that explicitly states that a project's www.eclipse.org/[shortname] website must always point to an eclipse.org property (and never a community page or vendor site).https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/113Make it clear that the project website must be hosted on EF managed servers2024-01-15T20:55:45ZEclipse WebmasterMake it clear that the project website must be hosted on EF managed servers## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#535141)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=535141)**
## Description
The section that discusses the project website implies, but does not state that the pr...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#535141)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=535141)**
## Description
The section that discusses the project website implies, but does not state that the project website must be hosted on EF managed servers.
That is, the website that the user ends up on by navigating to http://www.eclipse.org/`<short-name\>` must be running on EF infrastructure. This could be (as is default) the "PMI" page that's generated from project metadata, or a custom site that hosted on our www servers.
This URL must not, for example, redirect to a community portal.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/112Document CQ process exception for large numbers of third party JS files2020-11-25T19:36:46ZEclipse WebmasterDocument CQ process exception for large numbers of third party JS files## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#535078)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=535078)**
## Description
Projects that use JavaScript can expect to require many dozens or hundreds of relative...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#535078)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=535078)**
## Description
Projects that use JavaScript can expect to require many dozens or hundreds of relatively fine grained JavaScript "libraries". Creating a CQ for each library is time consuming both for committers and for the IP Team and--at least in the case of projects that require license certification only--not particularly valuable.
With the introduction of Type A IP due diligence, we have an opportunity to make review a little easier for all parties. We've started rolling this out with some test projects, and so should update the handbook to include discussion of this exception.
A single CQ can be used for some coherent grouping of JavaScript files (potentially from multiple sources) when:
* Type A due diligence will be applied;
* The aggregated content represents a coherent "thing"; and
* The source (i.e. unminified) files for all content is included.
A "coherent grouping" (or coherent "thing") means that the files must all be somehow related. They could be, for example, some bit of JavaScript along with the transitive closure of all of its dependencies. The coherent grouping should have a name (e.g. "Electron") and version which should be used as the description of the CQ.
Attach a single ZIP file to the CQ that includes all source content. Manifests, when available can also be included. In a comment on the CQ, include a list of the files by name.
Note that piggyback CQs are not supported for CQs of this nature. Exceptions may be granted at the IP Team discretion.
Take careful note that this applies only for Type A (license certification) due diligence.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/110Commit message conventions2020-11-25T19:36:42ZEclipse WebmasterCommit message conventions## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#534048)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=534048)**
## Description
Consider adding some further guidance regarding commit messages to the handbook.
The ...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#534048)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=534048)**
## Description
Consider adding some further guidance regarding commit messages to the handbook.
The Eclipse Project has some wiki content that looks useful:
https://wiki.eclipse.org/Platform_UI/How_to_Contribute#Commit_Message_Conventionshttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/109Include discussion of marking "works with" CQs to include later versions2020-11-25T19:36:40ZEclipse WebmasterInclude discussion of marking "works with" CQs to include later versions## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#533943)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=533943)**
## Description
Workswith CQs - There is no issue regarding appending "and later versions" to Workswit...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#533943)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=533943)**
## Description
Workswith CQs - There is no issue regarding appending "and later versions" to Workswith CQs generally. Feel free to do so at creation.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/108Describe how to get "admin" access to a project's GitHub repositories2020-11-25T19:36:37ZEclipse WebmasterDescribe how to get "admin" access to a project's GitHub repositories## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#533471)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=533471)**
## Description
Let's add some content to the handbook to tell project teams how to get temporary "mai...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#533471)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=533471)**
## Description
Let's add some content to the handbook to tell project teams how to get temporary "maintainer" status for project repositories.
Webmaster can grant temporary "maintainer" status for a project's GitHub repositories. A team might do this to protect branches or install hooks.
Must be requested/approved by project lead. Project lead may designate individuals.
Designated maintainers must not add or remove team members or otherwise change the status of project team members (e.g. must not designate additional maintainers).
Change is temporary. Will be undone in 24 hours (??)
Requests must be made via Bugzilla (Community/GitHub) so that they can be tracked. This process should be used sparingly. Excessive use should be brought to the attention of the PMC (we probably should define "excessive").
Is "maintainer" a team level or repository level designation? i.e. does a request need to include a list of repositories in their request?
Am I missing anything, Matt?https://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/106Add handbook content (FAQ?) to help committers get set up with GitHub2020-11-25T19:36:33ZEclipse WebmasterAdd handbook content (FAQ?) to help committers get set up with GitHub## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#532736)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=532736)**
## Description
I believe that the short answer is that committers need to provide their GitHub ID in ...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#532736)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=532736)**
## Description
I believe that the short answer is that committers need to provide their GitHub ID in their account and magic happens.
Matt, is there any more to this?
I think that this is directly related to content regarding EF Accounts, so I've added this as a blocker of [Bug 529033](https://bugs.eclipse.org/bugs/show_bug.cgi?id=529033).
### Blocking
* [Bug 529033](https://bugs.eclipse.org/bugs/show_bug.cgi?id=529033)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/105Integrate wiki content on contributing via git into the handbook2020-11-25T19:36:32ZEclipse WebmasterIntegrate wiki content on contributing via git into the handbook## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#532678)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=532678)**
## Description
There is some useful information on this page, including some potential FAQ entries.## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#532678)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=532678)**
## Description
There is some useful information on this page, including some potential FAQ entries.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/104Add help to validate whether or not a contributor has signed an ECA.2020-11-25T19:36:30ZEclipse WebmasterAdd help to validate whether or not a contributor has signed an ECA.## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#532676)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=532676)**
## Description
Provide some help for committers to find the ECA validation tool.
Something like this...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#532676)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=532676)**
## Description
Provide some help for committers to find the ECA validation tool.
Something like this, but rephrase.
--
There is a tool in you Eclipse Account page to determine whether or not a contributor has signed an ECA.
https://accounts.eclipse.org/user/eca
The hooks that we put onto the Git/Gerrit/GitHub repositories check this sort of thing automatically, but if you ever need to have that information, you can get it manually.
--
Include a screenshot.https://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)