Skip to content

Commit

Permalink
Remove obsolete documentation modules
Browse files Browse the repository at this point in the history 
Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
  • Loading branch information
@mandy-chessell
mandy-chessell committed Apr 19, 2022
1 parent 0ff2f6d commit 436e559
Show file tree
Hide file tree
Showing 1,112 changed files with 657 additions and 28,428 deletions.
7 changes: 0 additions & 7 deletions CODEOWNERS
View file
Validating CODEOWNERS rules …
Expand Up @@ -57,16 +57,11 @@ open-metadata-implementation/platform-services/ @mandy-chessell
open-metadata-implementation/view-services/ @davidradl


# Publication

open-metadata-publication/ @mandy-chessell

# Resources

open-metadata-resources/ @mandy-chessell
open-metadata-resources/open-metadata-deployment/ @planetf1
open-metadata-resources/open-metadata-deployment/sample-data/ @cmgrote
open-metadata-resources/open-metadata-tutorials/ @mandy-chessell

open-metadata-resources/open-metadata-samples/ @mandy-chessell
open-metadata-resources/open-metadata-samples/postman-rest-samples/ @planetf1
Expand Down Expand Up @@ -101,11 +96,9 @@ gradle/ @planetf1
.m2/ @planetf1
.gitignore @planetf1
.sonarcloud* @planetf1
Community-Guide.md @mandy-chessell @planetf1
INFO.yaml @planetf1
spotbugs* @planetf1
CODEOWNERS @mandy-chessell @planetf1
MAINTAINERS* @mandy-chessell
CONTRIBUTORS* @mandy-chessell
Egeria-Operations* @mandy-chessell
THIRD_PARTY.md @mandy-chessell @planetf1
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Expand Up @@ -7,7 +7,7 @@ This project welcomes contributors from any organization or background, provided
willing to follow the simple processes outlined below, as well as adhere to the
[Code of Conduct](https://github.com/odpi/specs/wiki/ODPi-Code-of-Conduct).

Review the [community guide](./Community-Guide.md) to find out more.
Review the [community guide](https://egeria-project.org/guides/community/) to find out more.



Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTORS.md
View file
Expand Up @@ -25,7 +25,7 @@ This file recognizes the people who have make an important contribution to Egeri
| Sachin Naik | sachin.naik@ibm.com |


To understand how to become an Egeria contributor see the [Egeria Operations Guide](Egeria-Operations.md).
To understand how to become an Egeria contributor see the [Egeria Operations Guide](https://egeria-project.org/guides/project-operations/).

----
License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
Expand Down
100 changes: 2 additions & 98 deletions Community-Guide.md
View file
Expand Up @@ -7,110 +7,14 @@ This project welcomes contributors from any organization or background, provided
willing to follow the simple processes outlined below, as well as adhere to the
[Code of Conduct](CODE_OF_CONDUCT.md).

## Joining the community

The community collaborates primarily through `Zoom` calls, `GitHub` and the instance messaging tool, `Slack`.
There is also a mailing list.

### Zoom calls

There are two regular online meetings using Zoom each week, both on a Tuesday. All are welcome.

* **Developers call** - one hour -
Discussion on code development - not minuted -

10 am (UK); 11 am (Amsterdam/CET); 12pm (Bucharest)

Zoom Conference [https://zoom.us/j/523629111](https://zoom.us/j/523629111)

* **Community call** - one hour -
Demos, meet-ups and other activities going on in the Egeria community

2pm (UK); 3pm (Amsterdam/CET); 4pm (Bucharest)

Zoom Conference [https://zoom.us/j/523629111](https://zoom.us/j/523629111)

Meeting Agenda and Minutes are here [https://github.com/odpi/data-governance/wiki](https://github.com/odpi/data-governance/wiki)


### Connecting to Slack

Egeria uses the [LF AI & Data Slack community](http://slack.lfai.foundation) to provide an ongoing dialogue between members.
This creates a recorded discussion of design decisions and discussions that complement the project meetings.

Follow the link above and register with the LF AI & Data slack service using your email address.
Once signed in you can see all of the active slack channels.
The main slack channel for the Egeria project is called `#egeria-discussion`

Additional channels are added from time to time as new workgroups and discussion topics are established. For Egeria these
channel names will begin with '#egeria'. You can also view slack channels from other LF AI & Data projects.


More information about slack is available in the [developer-resources/tools](developer-resources/tools/Slack.md) pages.

### Egeria's mailing list

Follow the link to review the [mailing list archives](https://lists.lfaidata.foundation/g/egeria-technical-discuss/topics)

### Other websites and resources

Below are links to websites and other resources for Egeria.

* [Egeria's Home Page](https://egeria.odpi.org) - documentation for Egeria
* [Egeria's Webinars](https://wiki.lfaidata.foundation/display/EG/Egeria+Webinar+program) - virtual events covering topics of interest.
* [Egeria's workshops](https://github.com/odpi/data-governance/tree/master/workshops) - face-to-face workshops promoting discussion and education on Egeria
* [Presentations on Egeria](https://github.com/odpi/data-governance/tree/master/presentations) - presentations given at conferences and private gatherings


## Egeria's Git repositories

The Egeria project used [GitHub](https://github.com/odpi)
to maintain its content. It has the following repositories:

* [egeria](https://github.com/odpi/egeria) - contains the core Egeria function along with samples, tutorials and documentation.
* [egeria-connector-hadoop-ecosystem](https://github.com/odpi/egeria-connector-hadoop-ecosystem) - contains connectors to integrate
technologies from the hadoop ecosystem into the open metadata ecosystem.
* [egeria-connector-ibm-information-server](https://github.com/odpi/egeria-connector-ibm-information-server) - contains connectors to integrate IBM Information Server into the open metadata ecosystem.
* [data-governance](https://github.com/odpi/data-governance) - contains Egeria's Guidance on Governance (GoG) as well as
large media files such as presentations and movies.
* [egeria-dev-projects](https://github.com/odpi/egeria-dev-projects) - contains fun projects for developers to help them learn about the Egeria technology.
* [egeria-palisade](https://github.com/odpi/egeria-palisade) - contains content from the collaboration between
the Egeria project and the [Palisade](https://github.com/gchq/palisade) project.

All of these repositories are publicly visible. However, if you want to contribute new content then you need
to create a GitHub account. This can be created from the top of the GitHub home page.

If you are not familiar with Git and GitHub, there is additional education in the
[developer-resources/tools](developer-resources/tools/Git-GitHub.md) pages.

## Steps to contribute content to the project

Egeria uses [GitHub's fork and pull model](https://help.github.com/articles/about-collaborative-development-models/)
to create a contribution.
This process is described in detail in the
[Egeria Dojo Education](open-metadata-resources/open-metadata-tutorials/egeria-dojo/egeria-dojo-day-2-3-contribution-to-egeria.md).

There are additional resources for contributors under [developer-resources](developer-resources).
Review the [developer guidelines](developer-resources/Developer-Guidelines.md)
to understand the requirements associated with new content for Egeria.

Every contribution is signed to say that the contributor has the rights to make the contribution and
agrees with the [Developer Certificate of Origin (DCO)](developer-resources/why-the-dco.md)

### Creating a Linux Foundation account

The Linux Foundation provide build and distribution facilities.
You need an account to access some of the reports from the build.

This is the link to create a [Linux Foundation account](https://identity.linuxfoundation.org).
Note the username and password you selected.
The [community guide](https://egeria-project.org/guides/community/) has moved to our new [documentation site](https://egeria-project.org/).

----
* Return to [Egeria's Home Page](https://egeria.odpi.org)
* Return to [Egeria's GitHub Top-level](https://github.com/odpi/egeria)


* Link to [Egeria's Operations Guide](Egeria-Operations.md)
* Link to [Egeria's Operations Guide](https://egeria-project.org/guides/project-operations/)


----
Expand Down
7 changes: 2 additions & 5 deletions Content-Organization.md
View file
Expand Up @@ -117,14 +117,11 @@ The Egeria core repository contains the core Egeria functionality, and is organi

* **[view-services](open-metadata-implementation/view-services)** - services that provide services for user interfaces. These run in the [View Server](open-metadata-implementation/admin-services/docs/concepts/view-server.md) OMAG Server.

* **[open-metadata-publication](open-metadata-publication)** - contains many of the general articles for Egeria's website.

* **[open-metadata-resources](open-metadata-resources)** - contains the open metadata demos and samples.
* **[open-metadata-archives](open-metadata-resources/open-metadata-archives)** - contains pre-canned collections of metadata for loading into an open metadata server.
* **[open-metadata-deployment](open-metadata-resources/open-metadata-deployment)** - contains resources for deploying ODPi Egeria and related technology.
* **[open-metadata-labs](open-metadata-resources/open-metadata-labs)** - contains Jupyter Notebooks to guide you through using ODPi Egeria.
* **[open-metadata-deployment](open-metadata-resources/open-metadata-deployment)** - contains resources for deploying Egeria and related technology.
* **[open-metadata-labs](open-metadata-resources/open-metadata-labs)** - contains Jupyter Notebooks to guide you through using Egeria.
* **[open-metadata-samples](open-metadata-resources/open-metadata-samples)** - contains coding samples for Egeria APIs.
* **[open-metadata-tutorials](open-metadata-resources/open-metadata-tutorials)** - contains tutorials for managing your own ODPi Egeria environment.

* **[open-metadata-test](open-metadata-test)** - supports additional test cases beyond unit test.

Expand Down
164 changes: 3 additions & 161 deletions Egeria-Operations.md
View file
Expand Up @@ -7,175 +7,17 @@ The Egeria project provides content (standards, data, code and documentation) th
across many types of organizations - from those that rely on data in their operation - to organizations that have products
or technology designed to help manage data and its related processing.

A project of this scope requires input from a wide range of subject matter experts with different backgrounds and allegiances.
A project of this scope requires input from a wide range of subject-matter experts with different backgrounds and allegiances.
As such we need a set of principles, roles and operating practices to ensure the results of our contributions are useful,
have high quality and are widely consumable.

## General principles

The principles set the tone of the operation of Egeria:

* The activities of the project ensure open collaboration.
Through this open collaboration we aim to build a community of people who are interested in the success of the project.
* The scope of the content is determined by the individuals who are actively contributing.
* The resulting content is licensed under the Apache 2.0 license.
* An individual's privileges and position is awarded through their contribution and engagement.

These principles should be respected as the procedures used to manage the Egeria project are evolved and matured.

## Egeria community members

Anyone can become a member of the Egeria community by signing up to the
the Egeria mailing list, joining the slack community, attending the project online meetings
or contributing content to one of more of the GitHub repositories.

The [Community Guide](./Community-Guide.md) describes how to connect to these channels.

All participants in the Egeria community are bound by the project's
[Code of Conduct](CODE_OF_CONDUCT.md).

As a member you are able to attend our meetings, just to listen, or to play an active part in the discussion.
The online meetings are recorded to allow community members to catch up if they are not able to attend the live meeting.
When you attend the community meetings specifically, your name will be recorded in the meeting minutes along with any remarks or suggestions you make.
The agenda and minutes of our community meetings are publicly available on the [Egeria wiki](https://github.com/odpi/egeria/wiki).

A member may make contributions to the Egeria content by submitting a
GitHub pull request on the appropriate Git repository.
This will be reviewed and processed by the **Egeria maintainers**.
The process for making a contribution is described in the
[Egeria Dojo](open-metadata-resources/open-metadata-tutorials/egeria-dojo) education.
Each contribution is signed by the contributor to confirm they
agree to our [Developer Certificate of Origin (DCO)](developer-resources/why-the-dco.md).

Community members can progress to be **Egeria Contributors** and then **Egeria Maintainers**.

### Egeria contributors

Egeria contributors are members who have actively taken additional steps to promote and foster the success of Egeria and its acceptance/adoption across the IT community. The activities that contributors engage in might include:

* Provide best practices for information governance, lineage, metadata management and other related disciplines during active discussions and/or development of material
* Actively participate in meetings and discussions
* Promote the goals of Egeria and the benefits of open metadata to the IT community (deliver presentations, informal talks, assist at trade shows, independent blogs, etc.)
* Assist in the recruitment of new members
* Contribute where appropriate to documentation and code reviews, specification development, demonstration assets and other artifacts that help move Egeria forward

#### How to become a contributor

Being recognized as an Egeria contributor is done by nomination of an Egeria maintainer with a majority vote
of Egeria maintainers to confirm. Once confirmed, you will receive
[an Egeria Contributor badge](developer-resources/badges) to add to
your social profiles and/or website, and can publicly refer to yourself as an Egeria contributor.

Egeria's contributors are recognized in the [contributors list](CONTRIBUTORS.md)

### Egeria project maintainers

Maintainers are members of the Egeria community that have permission to change the Egeria content.
This may be content that they have created themselves, or has been provided by another member.
Maintainers also have responsibility for helping other project members with their contributions.
This includes:
* Monitoring email aliases.
* Monitoring Slack (delayed response is perfectly acceptable).
* Triage GitHub issues and perform pull request reviews for other maintainers and the community.
* Make sure that ongoing git pull requests are moving forward at the right pace or closing them.
* In general continue to be willing to spend at least 25% of one's time
working on the project (approximately 1.25 business days per week).

#### How to become a maintainer

New maintainers are voted onto the maintainers list by the existing maintainers - see
[maintainer list](./MAINTAINERS.md).

A person wishing to become a maintainer sends a note to the existing mailing list
at egeria-technical-discuss@lists.lfaidata.foundation, listing their Egeria contributions to date and
requesting to be made a maintainer.
The maintainers vote and if a majority agree then the requester
is added to the maintainers list and given write access to the
[Egeria Git repositories](developer-resources/tools/Git-GitHub.md).

Once confirmed, you will receive an
[an Egeria Maintainer badge](developer-resources/badges) to add to
to add to your social profiles and/or website,
and can publicly refer to yourself as an Egeria maintainer.

#### When does a maintainer lose maintainer status

If a maintainer is no longer interested or cannot perform the maintainer duties listed above, they
should volunteer to be moved to emeritus status. In extreme cases this can also occur by a vote of
the maintainers per the voting process below.
Emeritus maintainers can rejoin the maintainer list through a vote of the
existing maintainers.

### Egeria leadership

The leadership of Egeria is granted through a vote of the Egeria maintainers.
Egeria is currently led by Mandy Chessell.

## Egeria project meetings

Some meetings are face-to-face, but most are conference calls.
Attendance at meetings is open to all. Conference calls can be joined without an explicit invitation.
However, due to physical security requirements at some of the venues we use,
it is necessary to ensure you are added to the invitee list of any face-to-face meetings
that you wish to attend and complete the necessary formalities for the venue.

For example, the face-to-face meeting may be at a conference that requires you to register for the conference to attend.
Or a meeting may be at an organization's offices that are required to maintain a list of everyone on site.

## Egeria on Slack

Egeria uses the [LF AI & Data Slack community](http://slack.lfai.foundation) to provide an ongoing dialogue between members.
This creates a recorded discussion of design decisions and discussions that complement the project meetings.

Follow the link above and register with the LF AI & Data slack service using your email address.
Once signed in you can see all of the active slack channels.
The main slack channel for the Egeria project is called [#egeria-discussion](https://lfaifoundation.slack.com/archives/C01F40J2XA8)

Additional channels are added from time to time as new workgroups and discussion topics are established. For Egeria these
channel names will begin with '#egeria', you can also view slack channels from other LF AI & Data projects.

## Egeria email

Egeria uses the [announce list](https://lists.lfaidata.foundation/g/egeria-announce/topics)
to advertise events and news for the community, in addition to the [discussion list](https://lists.lfaidata.foundation/g/egeria-technical-discuss/topics)
for more general discussion.

## Egeria content management tools

The Egeria content is managed in GitHub under [https://github.com/odpi/egeria](https://github.com/odpi/egeria).
It may be developed using patches, branches from master, or forks/git pull requests.
Each change should have a [GitHub issue](https://github.com/odpi/egeria/issues) explaining why the change is being made.
The new or updated content should follow the Egeria
[developer guidelines](https://egeria.odpi.org/developer-resources/Developer-Guidelines).

When new content proposed to the project, the person contributing is required to sign the contribution
to confirm it conforms to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/).

## Egeria project releases

The Egeria team aim to create an official release of the open metadata and governance capability every month.
This release will be available to include in products and other technology through
[Maven's Central Repository](https://search.maven.org), or through a download from the GitHub site.
Details of the releases are maintained in the [release notes](release-notes).

In between official releases, the latest build is also available to developers in GitHub.

The process for creating a release is described in the [developer-resources](developer-resources/Release-Process.md)

## Conflict resolution and voting

In general, we prefer that technical issues and maintainer membership are amicably worked out
between the persons involved. If a dispute cannot be decided independently, the maintainers can be
called in to decide an issue. If the maintainers themselves cannot decide an issue, the issue will
be resolved by voting. The voting process is a simple majority in which each maintainer receives one vote.
The [Operations Guide](https://egeria-project.org/guides/project-operations/) has moved to the new [Documentation Site](https://egeria-project.org/guides/project-operations/).

----
* Return to [Egeria's Home Page](https://egeria.odpi.org)
* Return to [Egeria's Home Page](https://egeria-project.org/)
* Return to [Egeria's GitHub Top-level](https://github.com/odpi/egeria)


* Link to [Egeria's Community Guide](Community-Guide.md)


----
License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
Expand Down

0 comments on commit 436e559

Please sign in to comment.