org.eclipse.dash.handbook issueshttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues2024-03-26T18:33:31Zhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/184Add a pointer to our hugo-eclipsefdn-website-boilerplate project2024-03-26T18:33:31ZChristopher Guindonchris.guindon@eclipse-foundation.orgAdd a pointer to our hugo-eclipsefdn-website-boilerplate projectWe created a Hugo boilerplate project to help projects migrate their PHP website to Hugo.
I recently made some updates to our docs with pointers on how they can ask for help:
https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-eclips...We created a Hugo boilerplate project to help projects migrate their PHP website to Hugo.
I recently made some updates to our docs with pointers on how they can ask for help:
https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-eclipsefdn-website-boilerplate#how-to-build-my-projects-website-with-jenkins
This is an example of one of the many ways a project can create a website. Projects are not required to use this, however, this is the solution that we support.
I think it would be a good idea to include a pointer in the handbook to our boilerplate. I expect us to refine the docs overtime.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/183Add information about Matrix to the handbook2024-03-22T03:33:22ZWayne BeatonAdd information about Matrix to the handbookWhat do we need to tell commmitters about Matrix?What do we need to tell commmitters about Matrix?https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/182Domains that leverage EF trademarks must be owned by the EF2024-01-15T21:11:07ZWayne BeatonDomains that leverage EF trademarks must be owned by the EFNote that we consider all distinctive names of Eclipse projects -- whether they are formally registered or not -- to be trademarks of the Eclipse Foundation (referred to as "common law" trademarks in many jurisdictions).
The handbook cu...Note that we consider all distinctive names of Eclipse projects -- whether they are formally registered or not -- to be trademarks of the Eclipse Foundation (referred to as "common law" trademarks in many jurisdictions).
The handbook currently places very strong limitations on the use of domains.
It's commonplace for projects to have their own domains. What's actually important is that -- in order for the EF to be able to provide certain protections for the trademarks -- the EF needs to own and manage any domain that leverages our trademarks. So... this is the actual rule: domains that leverage Eclipse Foundation trademarks must be owned by the Eclipse Foundation.
If a project team takes it upon themselves to acquire a domain, they must transfer ownership of that domain to the Eclipse Foundation. The Eclipse Foundation does not generally acquire domains on behalf of projects, selecting a domain (and how to pay for the initial acquisition of that domain) are matters for the project team to sort out.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/180Updates for Project Websites2023-10-19T09:02:02ZDenis RoyUpdates for Project WebsitesProject website URLs generally take the form `https://www.eclipse.org/<shortname>` (e.g. `https://www.eclipse.org/foo`
Please change to: Project website URLs generally take the form `https://eclipse.dev/<shortname>` (e.g. `https://eclip...Project website URLs generally take the form `https://www.eclipse.org/<shortname>` (e.g. `https://www.eclipse.org/foo`
Please change to: Project website URLs generally take the form `https://eclipse.dev/<shortname>` (e.g. `https://eclipse.dev/foo`https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/170Graphical view of release workflow(s)2023-03-23T18:43:42ZWayne BeatonGraphical view of release workflow(s)_Moved from the EDP repository; this belongs in the handbook_
#### Issue/Problem Description
* It's a bit hard from the doc to understand which workflow a release can use and what are the steps involved in term of approval. Understandin..._Moved from the EDP repository; this belongs in the handbook_
#### Issue/Problem Description
* It's a bit hard from the doc to understand which workflow a release can use and what are the steps involved in term of approval. Understanding what a release involves requires moving in multiple places of the document and reading a lot of text, many of it being conditional, making it harder to sort out what's the path for a given case.
#### Proposal
* I suggest we show on the EDP a graphical view of the workflow(s) for releases. If there is actually no flow, but just a list of independent requirement, we should show the checklist for each review explicitly.
* The EDP release process could be an appendix, just like the IP Due Diligence poster which is extremely good for IP concerns (that I believe happen to be harder on paper, but easier to undersand thanks to the poster)
#### Proposal Benefits
* People understand release process better and can better pick the right kind of release they need according to their project constraints.
#### Challenges
* If it's an appendix, no immediate challenge.
* If we're likely to update the process often, then having an extra document could be an additional maintenance effort and a risk of out-of-date content.
/cc @mistriaWayne BeatonWayne Beatonhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/168Add information about resource packs to the handbook2023-02-03T11:41:15ZFrederic Gurrfrederic.gurr@eclipse-foundation.orgAdd information about resource packs to the handbookThis should include the content of the following sections:
* https://wiki.eclipse.org/CBI#What.27s_provided.3F
* https://wiki.eclipse.org/CBI#Additional_Resource_Packs
Content can also be used from
* https://wiki.eclipse.org/Jenkins#Abo...This should include the content of the following sections:
* https://wiki.eclipse.org/CBI#What.27s_provided.3F
* https://wiki.eclipse.org/CBI#Additional_Resource_Packs
Content can also be used from
* https://wiki.eclipse.org/Jenkins#About_resource_packs_and_quotas
More important than technical details (number of CPUs and RAM), is probably the process of how resource packs are assigned (https://wiki.eclipse.org/CBI#Assigning_Resource_Packs_to_a_Project) and how projects/orgs can check the status of resource pack allocation (https://wiki.eclipse.org/CBI#Sponsored_Projects).https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/166Revise the Initial Contribution Process2022-12-19T03:57:39ZWayne BeatonRevise the Initial Contribution ProcessIn the past, we required that project teams provide a ZIP file containing a snapshot of their repository to the IP Team for review via IPZilla. The team was then "on hold" until the IP Team granted their approval to "check-in"; with that...In the past, we required that project teams provide a ZIP file containing a snapshot of their repository to the IP Team for review via IPZilla. The team was then "on hold" until the IP Team granted their approval to "check-in"; with that approval, the project team could then work with the IT team to move/create repositories.
With the changes in the IP Policy, we have an opportunity to improve this experience.
The short version is this:
* Complete the proposal process and creation review;
* Project team and EMO works with IT Team to move existing repositories (or create new ones) in EF GitLab or EF-managed GitHub;
* EMO will initiate the intellectual property review of the default branch of all repositories;
* The EMO IP Team will inform the EMO when the reviews are complete.
Note that the overall process likely takes the same amount of time with these revisions as it did in the past. The perception and general experience should, however, be better for the committer teams involved.
We need to take special care to ensure that project teams understand that when we move repositories under management of the EFs, the repositories will become immediately subject to our system's management of project roles. Write access to repositories will, for example, be limited to committers who are listed on the project proposal and have signed the necessary agreements.
That is, some committers may lose access during the transition period, so care should be taken with regard to timing of the move. It is a best practice, therefore, to wait until a critical mass of committers have been onboarded before starting to move any repositories.
Note that the process is basically the same when a repository of existing code is added to a running project. We can likely do something similar with pull requests that require review (more investigation required).
/cc @mdelgado624 @skilpatrick2022-12-16https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/164Update contact information to point people to create "help desk" issues2022-06-13T18:14:58ZWayne BeatonUpdate contact information to point people to create "help desk" issuesSome of the handbook has been updated to refer to help desk, but not all.
We should review references to the webmaster email address and determine whether or not a pointer to help desk is a better fit.Some of the handbook has been updated to refer to help desk, but not all.
We should review references to the webmaster email address and determine whether or not a pointer to help desk is a better fit.Wayne BeatonWayne Beatonhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/163Ability to display a summary of clearlydefined findings2022-05-18T06:34:18ZBoris BaldassariAbility to display a summary of clearlydefined findingsAs discussed during our last call, it would be great to have an option for dash that displays a summary of all findings retrieved from clearlydefined. The idea is to use this summary to build ORT's curations file afterwards.
If we get t...As discussed during our last call, it would be great to have an option for dash that displays a summary of all findings retrieved from clearlydefined. The idea is to use this summary to build ORT's curations file afterwards.
If we get the "canonical path" (e.g. `npm/npmjs/@fluentui/react-text/9.0.0-alpha.13`) or whatever similar format that can be easily transformed that'd be enough for our purpose.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/162Update the "Starting an Open Source Project at the Eclipse Foundation"2022-05-10T15:11:10ZWayne BeatonUpdate the "Starting an Open Source Project at the Eclipse Foundation"This section needs some work.
Here are some resources that might help:
* Add a Getting Started Checklist #54
* "The First 90 Days" #152
* Trademarks #118
* [Starting a Project at the Eclipse Foundation](https://www.eclipse.org/commun...This section needs some work.
Here are some resources that might help:
* Add a Getting Started Checklist #54
* "The First 90 Days" #152
* Trademarks #118
* [Starting a Project at the Eclipse Foundation](https://www.eclipse.org/community/eclipse_newsletter/2014/july/article2.php)Maria Teresa DelgadoMaria Teresa Delgadohttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/159Inform new committers of the mailing lists to which they will automatically b...2022-02-14T21:15:35ZWayne BeatonInform new committers of the mailing lists to which they will automatically be subscribedWe have some scripts that automagically subscribe committers to various mailing lists.
@webmaster, can you please confirm that these are the lists (are there any more?):
* eclipse.org-members-committers@eclipse.org
* eclipse.org-commit...We have some scripts that automagically subscribe committers to various mailing lists.
@webmaster, can you please confirm that these are the lists (are there any more?):
* eclipse.org-members-committers@eclipse.org
* eclipse.org-committers@eclipse.org
We need to ensure that new committers are aware that they they will automatically be subscribed and must remain subscribed as part of the process of becoming a committer.
Do we automatically subscribe committers to their project's dev list? (per comments on Bug 437377, I think that this is a bootstrapping problem).
We should include pointers to other lists that may be useful (e.g. project dev list, cbi-dev, cross-project-issues-dev).https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/158Describe the project termination process2022-02-08T22:05:28ZWayne BeatonDescribe the project termination processFrom [Bug 535766](https://bugs.eclipse.org/bugs/show_bug.cgi?id=535766)
> I searched the Eclipse Project Handbook (https://www.eclipse.org/projects/handbook/) for "Termination", because I wanted to provide a link to the process. I rememb...From [Bug 535766](https://bugs.eclipse.org/bugs/show_bug.cgi?id=535766)
> I searched the Eclipse Project Handbook (https://www.eclipse.org/projects/handbook/) for "Termination", because I wanted to provide a link to the process. I remember, somewhere, it was stated that the project is archived, but can be revived, if there is enough interest.
>
> However, I got two hits on "termination" only. And that was "termination reviews" only, without details. Do I mix things up with "Apache Attic" (http://attic.apache.org/)? - Especially "Process of leaving the Attic again)https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/157Describe how to create a "help desk" repository2022-01-06T14:29:18ZWayne BeatonDescribe how to create a "help desk" repositoryOn https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/187#note_440915, we discuss the creation of Eclipse project-specific help desk repositories. We should capture the conventions and practices for these in the handbook.On https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/187#note_440915, we discuss the creation of Eclipse project-specific help desk repositories. We should capture the conventions and practices for these in the handbook.Wayne BeatonWayne Beatonhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/155Describe the means by which a committer may request that a restructuring revi...2021-07-05T19:06:02ZWayne BeatonDescribe the means by which a committer may request that a restructuring review be scheduledTL;DR: contact the EMO.TL;DR: contact the EMO.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/154Describe the relationship between committer elections and committer agreements2021-05-05T17:59:22ZWayne BeatonDescribe the relationship between committer elections and committer agreementsFollowing a successful election, we go into a state where we are waiting for the newly elected committer to engage with us to ensure that the necessary agreements are in place. It's not obvious to an outside observer that anything is hap...Following a successful election, we go into a state where we are waiting for the newly elected committer to engage with us to ensure that the necessary agreements are in place. It's not obvious to an outside observer that anything is happening.
As a start, we should explain the steps that are happening in the background, and give folks some idea of how long they should wait before they contact us for more information.
Ideally, we should also mark up the election record in the PMI to have it indicate where in the provisioning process we are for the committer. I'll open a separate issue against PMI for that.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/153Terminating and Archiving a Project2021-04-26T18:32:25ZWayne BeatonTerminating and Archiving a ProjectDescribe what we do when a project is terminated and archived, including how a project may be revived from that state.Describe what we do when a project is terminated and archived, including how a project may be revived from that state.Wayne BeatonWayne Beatonhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/152Roll "The First 90 Days" into the Starting an Open Source Project section2022-05-10T15:11:11ZWayne BeatonRoll "The First 90 Days" into the Starting an Open Source Project sectionThere's some useful content on this page [The First 90 Days](https://wiki.eclipse.org/Development_Resources/The_First_90_Days). Let's roll it into the handbook and redirect this page to the handbook.There's some useful content on this page [The First 90 Days](https://wiki.eclipse.org/Development_Resources/The_First_90_Days). Let's roll it into the handbook and redirect this page to the handbook.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/151Role "Contributor Guide Recommendation" into the handbook2021-03-24T13:30:38ZWayne BeatonRole "Contributor Guide Recommendation" into the handbookMuch of the content from the [Contributor Guide Recommendation](https://wiki.eclipse.org/Architecture_Council/Contributor_Guide_Recommendation) is already in the handbook. Let's roll anything that's missing into the handbook and turn tha...Much of the content from the [Contributor Guide Recommendation](https://wiki.eclipse.org/Architecture_Council/Contributor_Guide_Recommendation) is already in the handbook. Let's roll anything that's missing into the handbook and turn that wiki page into a pointer to the handbook.https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/150Add a requirement/recommendation to provide a SECURITY file with project docu...2023-05-25T15:18:51ZWayne BeatonAdd a requirement/recommendation to provide a SECURITY file with project documentationConsider requiring/recommending that projects include a SECURITY file in their repositories.
The file should include a pointer to the [Eclipse Foundation Vulnerability Reporting Policy](https://www.eclipse.org/security/policy.php) along...Consider requiring/recommending that projects include a SECURITY file in their repositories.
The file should include a pointer to the [Eclipse Foundation Vulnerability Reporting Policy](https://www.eclipse.org/security/policy.php) along with implementation details that are specific to the project.
What implementation details should be included in the file?
* By what mechanism should vulnerabilities be reported
* How vulnerabilities are tracked by the project team
* By what criteria the project team will decide whether or not a CVE will be requested from the Eclipse Foundation
What else?Wayne BeatonWayne Beatonhttps://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/146Describe the relationship between Eclipse projects and working groups2021-01-21T11:04:44ZEclipse WebmasterDescribe the relationship between Eclipse projects and working groups## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#568453)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=568453)**
## Description
We need to describe the relationship between Eclipse projects and working groups in th...## Submitted by Wayne Beaton `@wbeaton`
**[Link to original bug (#568453)](https://bugs.eclipse.org/bugs/show_bug.cgi?id=568453)**
## Description
We need to describe the relationship between Eclipse projects and working groups in the handbook.