Commit 4d9ac2ca authored by Florent Zara's avatar Florent Zara
Browse files

more proofreading (bis)

parents 2e302b90 87f43fa4
Pipeline #21540 passed with stage
in 5 seconds
......@@ -28,7 +28,7 @@ We hold **regular meetings** open to everyone, to synchronise and report on our
The handbook is stored on [Git](https://gitlab.ow2.org/ggi/ggi), as [Markdown](https://about.gitlab.com/handbook/markdown-guide/) text.
### Using Markdown
Using Markdown makes it simple to integrate basic formatting while letting us focus on contents. It also means we can easily profit from the possibilities and automation services provided by GitLab because everyhing is stored as lightweight text files.
Using Markdown makes it simple to integrate basic formatting while letting us focus on contents. It also means we can easily profit from the possibilities and automation services provided by GitLab because everything is stored as lightweight text files.
You can read more about Markdown here: https://about.gitlab.com/handbook/markdown-guide/
But mostly, you can start by editing existing files and will quickly get the basics !
......@@ -40,7 +40,7 @@ Our workflow:
* The `main` [branch](https://gitlab.ow2.org/ggi/ggi/-/tree/main) contains the current text, as progressively reviewed and validated by peers.
* Updates and preparation of the next version happen in the `dev` [branch](https://gitlab.ow2.org/ggi/ggi/-/tree/dev) of the repository. These changes are regularly integrated into the `main` branch
* Previous stable releases of the Handbook can be found in [tags](https://gitlab.ow2.org/ggi/ggi/-/tags) (like snapshots)
* Any user can also create their own branch to work separatly before merging their work in the `dev` branch.
* Any user can also create their own branch to work separately before merging their work in the `dev` branch.
* You are also welcome to fork and submit merge requests into the repository. All contributions are discussed during our weekly meetings or on the mailing list.
### Build process
......@@ -51,10 +51,10 @@ The build process for the Handbook is documented in the dedicated directory: [/h
The OSPO.Zone website is hosted on the [Eclipse Foundation's GitLab](https://gitlab.eclipse.org/eclipse/plato/www) and is operated as a standard open source repository: anybody can fork it and submit a pull request. There is a pool of diverse maintainers who will check and merge the proposed changes as they happen. If in doubt, please submit an issue on the project or ask on one of the mailing lists (GGI, ospo.zone).
## Contributing to the Resource Center
## Contributing to the Resource Centre
The [GGI resource centre](https://www.ow2.org/view/OSS_Governance/) contains a lot of resources and information from the beginning of the initiative.
To contribute, please follow the instruction below in this page.
To contribute, please follow the instructions below in this page.
## Registering on the OW2 GitLab instance
......@@ -67,7 +67,7 @@ To contribute to the GGI Resource Centre and GitLab Handbook, please follow thes
From there, depending on what you want to access:
* To access the GitLab group: login once to https://gitlab.ow2.org with your OW2 credentials, then let us know when it's done, and we'll grant you access to the GGI group in GitLab.
* To edit the [Resource Center](https://www.ow2.org/view/OSS_Governance/): send us your username, and we'll grant you appropriate access.
* To edit the [Resource Centre](https://www.ow2.org/view/OSS_Governance/): send us your username, and we'll grant you appropriate access.
* For access to Rocket.Chat you need to:
- Login at least once on https://gitlab.ow2.org using your OW2 credentials.
- Open Rocket.Chat and choose a Rocket.Chat username when prompted.
......@@ -79,6 +79,6 @@ From there, depending on what you want to access:
Please note that we have, and enforce, a [code of conduct](https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php) to ensure a fair, respectful, inclusive and welcoming community.
This applies to all activity and communications around the initiative, from mailing lists to virtual meetings and real-life gatherings. We are deeply committed to its inforcement, so please do not hesitate to contact us for any question, request or complaint.
This applies to all activity and communications around the initiative, from mailing lists to virtual meetings and real-life gatherings. We are deeply committed to its enforcement, so please do not hesitate to contact us for any question, request or complaint.
Some parts of the site, like [OnRamp](/onramp/), also use the [Chatham House rule](https://www.chathamhouse.org/about-us/chatham-house-rule), so please be responsible when quoting people here.
# Roadmap for v1.1
See the [draft roadmap](https://pad.castalia.camp/p/roadmap-v2-uxk0nsc) and the [minutes of the vote](https://pad.castalia.camp/p/meetings-2022-05-31-1w30p0y).
## Handbook
* Update to v1.1 (for late october/beginning of november, before OS Experience 8-9 Nov)
- Update references and resources, check links for 404s.
- Add relationships between activities? (would help suggest new activities when completing one / when starting)
- Keep up to date and improve the Resource Centre
* Update to v2.0
- Improve method first chapters
- Add specific advice for contexts (administrations, not-for-profit, etc.)
- New activities, if we get some feedback suggesting so? No hard requirement here, but new feedback could change that.
## Translations
* Set up a dedicated page or system (Translation Management System) to help with translations.
* Set the path for translations, with no hard commitment for this iteration:
- Portuguese with Gerardo Lisboa.
- French?
- Spanish?
- German?
## GGI Deployment
We need to provide a way for people to discover and experiment with the GGI approach.
Two approaches have been discussed:
* A set of scripts, working on a GitLab / GitHub project, that:
- creates the activities,
- publishes a static website with the updated current status (based on activities),
* A QMS-like system that provides a better user experience and more advanced features:
- provide a way to define where you are, then propose actions, then record the output/proofs.
As voted during our last meeting of May, this iteration will focus on the first option: Issue-based deployment.
## Use cases / Communication
We need to gather market feedbacks thru customer uses cases and community of interest
* Establish and agree on action plan to gather customer use cases (industry, organisations of different sizes)
* Extend community reach & awareness thru communication plan
- Events: France: OSXP, OW2con, …
- Organisations: Numeum, Pole Systematic, CRIP, TOSIT, CIGREF
- Communication drum beat
- content: roadmap, feature poll, uses cases
- channel: linkedin, twitter, …
- OW2con
- Justin Colaninno Keynote
- Roundtable ()
- OSPO agenda topics but ot GGI specifics
- 15th anniversary Roundtable (TBC)
- OSXP
- CFP
- OpenCIO Summit
## Infra / Support
* We will need to regularly update the resource centre if we are to use it and communicate on it.
* There are a bunch of interesting resources in the handbook + the resource centre, it would be nice to have a script that extracts links and resources from these two sources (handbook + resource centre) and publish them somewhere. (on the ospo.zone website?)
......@@ -77,7 +77,7 @@ The following great people have contributed to the Good Governance Initiative:
## Licence
This work is licenced under a [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) license (CC-BY 4.0). From the Creative Commons website:
This work is licenced under a [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) licence (CC-BY 4.0). From the Creative Commons website:
> You are free to:
> * Share it — copy and redistribute the material in any medium or format
......
......@@ -2,7 +2,7 @@
## Terminology
The OSS Good Governance methodology blueprint is structured around four key concepts: Goals, Canonical Activities, Customized Activity Scorecards and Iteration.
The OSS Good Governance methodology blueprint is structured around four key concepts: Goals, Canonical Activities, Customised Activity Scorecards and Iteration.
* **Goals**: A Goal is a set of activities associated with a common area of concern, there are five Goals: Usage Goal, Trust Goal, Culture Goal, Engagement Goal and Strategy Goal. Goals can be achieved independently, in parallel, and iteratively refined through Activities.
* **Canonical Activities**: within a Goal, an Activity addresses a single concern or topic of development -- such as Managing legal compliance -- that can be used as an incremental step towards the program's objectives. The complete set of Activities as defined by the GGI are called the Canonical Activities.
......@@ -21,7 +21,7 @@ The Canonical Activities defined by the GGI are organised in Goals. Each Goal ad
## Canonical Activities
The Canonical Activities are at the center of the GGI blueprint. In its initial version, the GGI Methodology provides five Canonical Activities per goals, 25 in total. Canonical Activities are described using the following pre-defined sections:
The Canonical Activities are at the centre of the GGI blueprint. In its initial version, the GGI Methodology provides five Canonical Activities per goal, 25 in total. Canonical Activities are described using the following predefined sections:
* _Description_: a summary of the topic that the activity addresses and the steps to completion.
* _Opportunity Assessment_: describes why and when it is relevant to undertake this activity.
* _Progress Assessment_: describes how to measure progress on the activity and to assess its success.
......@@ -36,7 +36,7 @@ This section provides a high-level description of the Activity, a summary of the
To help structure an iterative approach, each activity has an "Opportunity Assessment" section, with one or more questions attached to it. The opportunity assessment focuses on why it is relevant to undertake this activity, what needs it addresses. Assessing the opportunity will help define what are the efforts expected, resources needed, and help evaluate costs and expected ROI.
### Progress Assessment
This step focuses on defining objectives, KPIs, and on providing _verification points_ that help evaluate progress in the Activity. The verification points are suggested, they can help define a roadmap for the Good Governance process, its priorities and how will progress be measured.
This step focuses on defining objectives, KPIs, and on providing _verification points_ that help evaluate progress in the Activity. The verification points are suggested, they can help define a roadmap for the Good Governance process, its priorities and how progress will be measured.
### Tools
Here are listed Tools that can help in delivering the activity or instrument a specific step of the activities. Tools are not a mandatory recommendation, nor pretend to be exhaustive, but are suggestions or categories to be elaborated upon based on existing context.
......@@ -45,7 +45,7 @@ Here are listed Tools that can help in delivering the activity or instrument a s
This section is regularly updated with feedbacks from users and all sorts of recommendations that can help manage the Activity.
### Resources
Resources are proposed to feed the approach with background studies, reference documents, events or online content to enrich, develop the related approach on the activity. Resources are not exhaustive, they are starting points or suggestions to expand on the semantics of the activity according to one's own context.
Resources are proposed to feed the approach with background studies, reference documents, events or online content to enrich and develop the related approach on the activity. Resources are not exhaustive, they are starting points or suggestions to expand on the semantics of the activity according to one's own context.
## Customised Activity Scorecards
......
# Methodology
Implementing the OSS Good Governance methodology is ultimately a consequential and impactful initiative. It involves several categories of company people, services, and processes, from everyday practices to HR management and from developers to C-level executives. There really is no silver bullet mechanism to implement open source good governance. Different types of organisation and company cultures and situation will demand different approaches to open source governance. For each organisation, there will be different constraints and expectations, leading to different paths and ways of managing the programme.
Implementing the OSS Good Governance methodology is ultimately a consequential and impactful initiative. It involves several categories of company people, services, and processes, from everyday practices to HR management and from developers to C-level executives. There really is no silver bullet mechanism to implement open source good governance. Different types of organisation and company cultures and situations will demand different approaches to open source governance. For each organisation, there will be different constraints and expectations, leading to different paths and ways of managing the programme.
With this in mind the Good Governance Initiative provides a generic blueprint of activities that can be tailored to an organisation's own domain, culture and requirements. While the blueprint claims to be comprehensive, the methodology can be implemented progressively. It is possible to bootstrap the program by simply selecting the most relevant Goals and Activities in one's specific context. The idea is to build a first-draft roadmap to help set up the local initiative.
......@@ -47,7 +47,7 @@ In the context of a live OSPO program this is highly relevant, as many side aspe
Ideally, the methodology could be implemented in five phases as follows:
1. **Discovery** Understanding key concepts, taking ownership of the methodology, aligning goals expectations.
1. **Customisation** Adapting Activity description and opportunity assessment to organisation specifics.
1. **Prioritisation** Identifying objectives and key results tasks and tools, scheduling milestones and drafting timeline.
1. **Prioritisation** Identifying objectives and key results, tasks and tools, scheduling milestones and drafting timeline.
1. **Activation** Finalising Scorecard, budget, assignments, document tasks on issue manager.
1. **Iteration** Assessing and scoring results, highlighting issues, improving, adjusting. Iterate every quarter or semester.
......
......@@ -30,7 +30,7 @@ This activity helps identify areas where training could help people become more
The following **verification points** demonstrate progress in this activity:
- [ ] A skills matrix is developed.
- [ ] The scope of OSS technologies used is proactively defined, i.a. avoiding uncontrolled use of OSS technologies.
- [ ] The scope of OSS technologies used is proactively defined, i.e. avoiding uncontrolled use of OSS technologies.
- [ ] A satisfactory level of expertise is acquired for these technologies.
- [ ] Teams have received an "open source Basics" training to get started.
......
......@@ -20,8 +20,8 @@ In order to mitigate these risks, one has to set up an assessment program of its
Any company that uses software has to watch its vulnerabilities in:
* its infrastructure (e.g. Cloud infrastructure, network infrastructure, data stores),
* its business applications (HR, CRM tools, internal and customers-related data management),
* its in-house code: e.g. the company's website, internal development projects, etc., and
* all direct and indirect software and services dependencies.
* its in-house code: e.g. the company's website, internal development projects, etc.,
* and all direct and indirect software and services dependencies.
The ROI of vulnerabilities is little known until something bad happens. One has to consider the consequences of a major data breach or unavailability of services to estimate the true cost of vulnerabilities.
......
......@@ -53,7 +53,7 @@ The following **verification points** demonstrate progress in this Activity:
* Skills matrix.
* Public training programs (ex. open source school).
* Sourcing: GitHub, GitLab, LinkedIn, Meetups, Epitech, Epita ...
* Sourcing: GitHub, GitLab, LinkedIn, Meetups, Epitech, Epita
* Contract templates (Loyalty clause).
* Job descriptions (templates) & career steps (templates).
......
......@@ -40,5 +40,5 @@ The following **verification points** demonstrate progress in this Activity: Ups
> Upstream First means that whenever you solve a problem in your copy of the upstream code which others could benefit from, you contribute these changes back upstream, i.e. you send a patch or open a pull request to the upstream repository.
* [What is Upstream and Downstream in Software Development?](https://reflectoring.io/upstream-downstream/) A crystal clear explanation.
* A paper by Dave Neary: [Upstream first: Building products from open source software](https://inform.tmforum.org/features-and-analysis/2017/05/upstream-first-building-products-open-source-software/).
* Explained from the Chromium OS design documents: [Upstream First] (https://www.chromium.org/chromium-os/chromiumos-design-docs/upstream-first).
* Explained from the Chromium OS design documents: [Upstream First](https://www.chromium.org/chromium-os/chromiumos-design-docs/upstream-first).
* Red Hat on upstream and the advantages of [upstream first](https://www.redhat.com/en/blog/what-open-source-upstream).
#!/bin/sh
cd $(dirname $0)
# Update contributing guide from repo
echo '---
title: GGI - Contributing
layout: default
......@@ -9,5 +11,14 @@ layout: default
' > content/CONTRIBUTING.md
cat ../CONTRIBUTING.md >> content/CONTRIBUTING.md
# Update roadmap from repo
echo '---
title: GGI - Roadmap
layout: default
---
' > content/Roadmap.md
cat ../Roadmap.md >> content/Roadmap.md
hugo version
hugo
......@@ -46,15 +46,19 @@ theme = "researcher"
[[menu.main]]
name = "Meetings"
url = "/contributing#discussions-and-meetings"
weight = 2
weight = 3
[[menu.main]]
name = "Roadmap"
url = "/Roadmap"
weight = 4
[[menu.main]]
name = "GitLab"
url = "https://gitlab.ow2.org/ggi/ggi"
weight = 3
weight = 5
[[menu.main]]
name = "OSPO.Zone"
url = "https://ospo.zone"
weight = 4
weight = 6
[markup.goldmark.renderer]
unsafe = true # allow raw HTML in markdown files
---
title: GGI - Contributing
layout: default
---
# Contributing to the GGI
The Good Governance Initiative is a sub-working group of the [OSPO Alliance](https://ospo.zone/) and is hosted on the [OW2 forge](https://gitlab.ow2.org/ggi).
We are open to contributions, and all our activity is open and public. No registration, no fees are required, and write access to the repositories is granted according to merit and participation.
Everything developed here is licensed under the [CC-BY licence 4.0](https://creativecommons.org/licenses/by/4.0/).
## Discussions and meetings
To join the conversation, the best way is to **introduce yourself on our mailing list**: <https://mail.ow2.org/wws/info/ossgovernance>.
This is where public discussions take place - you can register freely at [this link](https://mail.ow2.org/wws/subscribe/ossgovernance).
We hold **regular meetings** open to everyone, to synchronise and report on our progress.
- They usually take place on Tuesday at 5pm CEST on [Jitsi](https://jitsi.hivane.net/OW2OSSGoodGovernance). No registration is required, just connect and join the discussion.
- Minutes are publicly available in this [Pad folder](https://pad.castalia.camp/mypads/?/mypads/group/ggi-minutes-zz1b0nmd/view).
- Previous meeting minutes are stored in the [OW2 Nextcloud instance](https://nextcloud.ow2.org).
## Collaboration tools
* Current work takes place on OW2 GitLab [GGI project](https://gitlab.ow2.org/ggi/ggi).
* **Current tasks** are tracked as issues in [ggi/ggi](https://gitlab.ow2.org/ggi/ggi/-/issues/).
* We use [Pads](https://pad.castalia.camp/mypads/?/mypads/group/ggi-ri40n2d/view) for collaborative work.
* Public weekly meetings.
* Weekly calls take place on this Jitsi room: https://jitsi.hivane.net/OW2OSSGoodGovernance
## Contributing to the GGI Handbook
The handbook is stored on [Git](https://gitlab.ow2.org/ggi/ggi), as [Markdown](https://about.gitlab.com/handbook/markdown-guide/) text.
### Using Markdown
Using Markdown makes it simple to integrate basic formatting while letting us focus on contents. It also means we can easily profit from the possibilities and automation services provided by GitLab because everyhing is stored as lightweight text files.
You can read more about Markdown here: https://about.gitlab.com/handbook/markdown-guide/
But mostly, you can start by editing existing files and will quickly get the basics !
### Using GitLab
Using Git and GitLab is a great way to collaborate transparently, making peer review, commenting, automatic PDF and Website creation possible.
Our workflow:
* The `main` [branch](https://gitlab.ow2.org/ggi/ggi/-/tree/main) contains the current text, as progressively reviewed and validated by peers.
* Updates and preparation of the next version happen in the `dev` [branch](https://gitlab.ow2.org/ggi/ggi/-/tree/dev) of the repository. These changes are regularly integrated into the `main` branch
* Previous stable releases of the Handbook can be found in [tags](https://gitlab.ow2.org/ggi/ggi/-/tags) (like snapshots)
* Any user can also create their own branch to work separatly before merging their work in the `dev` branch.
* You are also welcome to fork and submit merge requests into the repository. All contributions are discussed during our weekly meetings or on the mailing list.
### Build process
The build process for the Handbook is documented in the dedicated directory: [/handbook/README.md](https://gitlab.ow2.org/ggi/ggi/-/blob/main/handbook/README.md).
## Contributing to the ospo.zone website
The OSPO.Zone website is hosted on the [Eclipse Foundation's GitLab](https://gitlab.eclipse.org/eclipse/plato/www) and is operated as a standard open source repository: anybody can fork it and submit a pull request. There is a pool of diverse maintainers who will check and merge the proposed changes as they happen. If in doubt, please submit an issue on the project or ask on one of the mailing lists (GGI, ospo.zone).
## Contributing to the Resource Center
The [GGI resource centre](https://www.ow2.org/view/OSS_Governance/) contains a lot of resources and information from the beginning of the initiative.
To contribute, please follow the instruction below in this page.
## Registering on the OW2 GitLab instance
You do not have to register on the GitLab instance to join the conversation and participate, however contributions need to be reviewed and as such require to work on forks or in specific branches, which implies to get a (free) account on the forge.
To contribute to the GGI Resource Centre and GitLab Handbook, please follow these instructions:
* Create your (free) OW2 user account at https://www.ow2.org/view/services/registration
* Login once at https://www.ow2.org/
From there, depending on what you want to access:
* To access the GitLab group: login once to https://gitlab.ow2.org with your OW2 credentials, then let us know when it's done, and we'll grant you access to the GGI group in GitLab.
* To edit the [Resource Center](https://www.ow2.org/view/OSS_Governance/): send us your username, and we'll grant you appropriate access.
* For access to Rocket.Chat you need to:
- Login at least once on https://gitlab.ow2.org using your OW2 credentials.
- Open Rocket.Chat and choose a Rocket.Chat username when prompted.
- Go to the #general channel and ask for GGI channel access there.
- Once access is granted, you should be able to access the #good-governance channel.
## Code of conduct
Please note that we have, and enforce, a [code of conduct](https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php) to ensure a fair, respectful, inclusive and welcoming community.
This applies to all activity and communications around the initiative, from mailing lists to virtual meetings and real-life gatherings. We are deeply committed to its inforcement, so please do not hesitate to contact us for any question, request or complaint.
Some parts of the site, like [OnRamp](/onramp/), also use the [Chatham House rule](https://www.chathamhouse.org/about-us/chatham-house-rule), so please be responsible when quoting people here.
---
title: GGI - Roadmap
layout: default
---
# Roadmap for v1.1
See the [draft roadmap](https://pad.castalia.camp/p/roadmap-v2-uxk0nsc) and the [minutes of the vote](https://pad.castalia.camp/p/meetings-2022-05-31-1w30p0y).
## Handbook
* Update to v1.1 (for late october/beginning of november, before OS Experience 8-9 Nov)
- Update references and resources, check links for 404s.
- Add relationships between activities? (would help suggest new activities when completing one / when starting)
- Keep up to date and improve the Resource Center
* Update to v2.0
- Improve method first chapters
- Add specific advice for contexts (administrations, not-for-profit, etc.)
- New activities, if we get some feedback suggesting so? No hard requirement here, but new feedback could change that.
## Translations
* Set up a dedicated page or system (Translation Management System) to help with translations.
* Set the path for translations, with no hard commitment for this iteration:
- Portuguese with Gerardo Lisboa.
- French?
- Spanish?
- German?
## GGI Deployment
We need to provide a way for people to discover and experiment with the GGI approach.
Two approaches have been discussed:
* A set of scripts, working on a GitLab / GitHub project, that:
- creates the activities,
- publishes a static website with the updated current status (based on activities),
* A QMS-like system that provides a better user experience and more advanced features:
- provide a way to define where you are, then propose actions, then records the output/proofs.
As voted during our last meeting of May, this iteration will focus on the first option: Issue-based deployment.
## Use cases / Communication
We need to gather market feedbacks thru customer uses cases and community of interest
* Establish and agree on action plan to gather customer use cases (industry, organization different sizes)
* Extend community reach & awareness thru communication plan
- Events: France: OSXP, OW2con, ..
- Organizations: Numeum, Pole Systematic, CRIP, TOSIT, CIGREF
- Communication drum beat
- content: roadmap, feature poll, uses cases
- channel: linkedin, twitter, ..
- OW2con
- Justin Colaninno Keynote
- Roundtable ()
- OSPO agenda topics but ot GGI specifics
- 15th anniversary Rountable (TBC)
- OSXP
- CFP
- OpenCIO Summit
## Infra / Support
* We will need to regularly update the resource center if we are to use it and communicate on it.
* There are a bunch of interesting resources in the handbook + the resource center, it would be nice to have a script that extracts links and resources from these two sources (handbook + resource center) and publish them somewhere. (on the ospo.zone website?)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment