Skip to content
This repository was archived by the owner on Dec 10, 2024. It is now read-only.

Commit

Permalink
Merge pull request #55 from russelltrow/documentation-navigation
Browse files Browse the repository at this point in the history
Improvements to the documentation navigation. Looks good to me!
  • Loading branch information
tmcclell authored Oct 9, 2023
2 parents a4deed1 + b8f275c commit 64552da
Show file tree
Hide file tree
Showing 14 changed files with 66 additions and 37 deletions.
2 changes: 1 addition & 1 deletion antitrust.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Antitrust Policy Notice
nav_order: 2
nav_order: 99
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

Expand Down
9 changes: 9 additions & 0 deletions guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: Guidelines
nav_order: 12
has_children: true
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

# Guidelines
5 changes: 3 additions & 2 deletions inactivity.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: default
title: Maintainer and Repository Inactivity
nav_order: 6
title: Inactivity Policies
nav_order: 10
parent: Project Lifecycle
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

Expand Down
24 changes: 5 additions & 19 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,14 @@
---
layout: default
title: Green Software Foundation OC
title: Oversight Committee (OC)
nav_order: 1
has_children: true
has_toc: false
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

# The Green Software Foundation Oversight Committee

Governing Documents:
The Oversight Committee is made up of the Working Group chairs and Project Leads for active projects.

* [Antitrust Policy](./antitrust.md)
* [Project Incubation Exit Criteria](./project-incubation-exit.md)
* [Project Lifecycle](./project-lifecycle.md)
* [Release Taxonomy](./release-taxonomy.md)
* [Maintainer and Repository Inactivity](./inactivity.md)

Guidelines:

* [Repository Structure](./repository-structure.md)
* [Project Incubation Entry Considerations](./project-incubation-entry-considerations.md)
* [Raising an issue with the OC](./raising-an-issue.md)

Miscellaneous:

* [OC Members](./oc-members.md)
* [OC Responsibilities](./oc-responsibilities.md)
* [OC Governance](./oc-governance.md)
Whereas the Steering Committee (SC) is more focused on long term strategic direction of the Foundation the Oversight Committee is more focused on tactical, day to day aspects of running the Foundation.
5 changes: 3 additions & 2 deletions oc-governance.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: default
title: OC governance
nav_order: 22
title: OC Governance
nav_order: 4
parent: Oversight Committee (OC)
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

Expand Down
6 changes: 4 additions & 2 deletions oc-members.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
layout: default
title: OC members
nav_order: 20
title: OC Members
nav_order: 2
parent: Oversight Committee (OC)
nav_exclude: true
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

Expand Down
7 changes: 4 additions & 3 deletions oc-responsibilities.md → oc-responsbilities.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
layout: default
title: OC responsibilities
nav_order: 21
title: OC Responsibilities
nav_order: 3
parent: Oversight Committee (OC)
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

# The Green Software Foundation Oversight Committee (OC) responsibilities
# Responsibilities

* Coordinating the technical direction of the Green Software Foundation.
* Approving project proposals (including, but not limited to, incubation, deprecation and changes to a project’s charter or scope) in accordance with a project lifecycle document to be developed, approved and maintained by the OC.
Expand Down
3 changes: 2 additions & 1 deletion project-donations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: default
title: Donating a Project
nav_order: 6
nav_order: 11
parent: Project Lifecycle
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

Expand Down
8 changes: 8 additions & 0 deletions project-incubation-entry-considerations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Project Incubation Entry
nav_order: 6
parent: Project Lifecycle
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

# Project Incubation Entry Considerations
This document provides information to help people who are considering bringing their projects to Green Software Foundation for [Incubation](./project-lifecycle.md#incubation). Specifically, it will outline items that the OC will take into consideration when evaluating the project, as well as, some best practices that have been followed by other projects prior to the project proposal being submitted to the OC. Our hope is that this document will smooth the entry process for new projects being proposed. The [project proposal process](./project-lifecycle.md#proposal) and the [template for project proposals](https://hyperledger.github.io/hyperledger-hip/) are outlined outside of this document. The goal of Incubation within Green Software Foundation is to provide a space for projects that have high potential to grow in the community. Ideas should start in [Green Software Foundation Labs](https://labs.hyperledger.org/).

Expand Down
5 changes: 3 additions & 2 deletions project-incubation-exit.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: default
title: Project Incubation Exit Criteria
nav_order: 5
title: Project Incubation Exit
nav_order: 7
parent: Project Lifecycle
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

Expand Down
4 changes: 3 additions & 1 deletion project-lifecycle.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
layout: default
title: Project Lifecycle
nav_order: 6
nav_order: 5
has_children: true
has_toc: false
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

Expand Down
14 changes: 11 additions & 3 deletions raising-an-issue.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# Raising an Issue with the Oversight Committee (OC)
---
layout: default
title: Raising an Issue
nav_order: 12
parent: Oversight Committee (OC)
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

# Raising an Issue with the Oversight Committee

Issues specific to a project should first be raised within the project itself. Each project provides a system such as GitHub Issues for this purpose, as well as the contact information for its maintainers. However, if the issue is broader in nature or if you are not satisfied with the disposition by the project you may bring it up to the OC for consideration. Such examples include the case where a project is evolving in a different direction than what is expected or where the project falls short of meeting the expectations set by the original project proposal.

There are several ways you can bring up an issue to the OC. The most direct one is to simply open an issue in [the OC GitHub repository](https://github.com/Green-Software-Foundation/toc/issues) or to send an email to [the OC mailing list](toc@greensoftware.foundation).
There are several ways you can bring up an issue to the OC. The most direct one is to simply open an issue in [the OC GitHub repository](https://github.com/Green-Software-Foundation/oc/issues) or to send an email to [the OC mailing list](mailto:oc@greensoftware.foundation).

Please, provide all relevant background information when raising an issue so that the OC is fully equiped to process it. Failing to do so will lead the OC to ask for that information as a first step and delay processing.

If you are unsure about how to proceed or would like to raise an issue privately consider contacting one of the [OC members](./toc-members.md).
If you are unsure about how to proceed or would like to raise an issue privately consider contacting one of the [OC members](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/13795331/Oversight+Committee).
3 changes: 2 additions & 1 deletion release-taxonomy.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: default
title: Release Taxonomy
nav_order: 7
nav_order: 14
parent: Guidelines
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

Expand Down
8 changes: 8 additions & 0 deletions repository-structure.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Repository Structure
nav_order: 13
parent: Guidelines
---
[//]: # (SPDX-License-Identifier: CC-BY-4.0)

# Common Repository Structure

Green Software Foundation projects are required to maintain a standard set of files in each repository. This
Expand Down

0 comments on commit 64552da

Please sign in to comment.