Skip to content

Commit

Permalink
GITBOOK-40: update docs structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Open Source Community Africa authored and gitbook-bot committed Oct 30, 2023
1 parent 558fc7a commit eaac4f3
Show file tree
Hide file tree
Showing 15 changed files with 100 additions and 76 deletions.
Binary file added .gitbook/assets/NXTBC.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/OSCA Logo_Colored.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 53 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,96 +1,110 @@
# Home

[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](./#contributors-)
[![All Contributors](https://img.shields.io/badge/all\_contributors-6-orange.svg?style=flat-square)](./#contributors-)

**Open Source Community Africa** is for open-source lovers, enthusiasts, advocates, and experts within and across Africa with the sole aim of increasing the rate of credible contributions by African software developers, designers, writers, and everyone involved in the sphere of technology to open source projects both locally and globally, changing the perception of Africans from just the billion users to the **NEXT BILLION CREATORS**.

![](.gitbook/assets/osca-logo_colored.png)
![](<.gitbook/assets/OSCA Logo\_Colored.png>)

Welcome to our documentation guide for members looking to know more about **Open Source Community Africa** and also make a contribution to any of our projects. This documentation is a work in progress, please feel free to contribute and give us feedback.

To suggest changes, click the GitHub icon on any docs page and make a pull request. If you're not sure how to do that, read our [documentation contribution guidelines](https://github.com/oscafrica/documentation/blob/master/contributing/documentation/guidelines.md).

If you need more help, please contact us at [[email protected]](mailto:[email protected]) or join the `#documentation` channel on our [Discord](https://bit.ly/osca-discord) server.
To suggest changes, click the GitHub icon on any docs page and make a pull request. If you're not sure how to do that, read our [documentation contribution guidelines](https://github.com/oscafrica/documentation/blob/master/contributing/documentation/guidelines.md). If you need more help, please contact us at [[email protected]](mailto:[email protected]) or join the `#documentation` channel on our [Discord](https://bit.ly/osca-discord) server.

## Get Started

Want to know more about Open Source Community Africa? Read our **Introduction** section:

{% page-ref page="about/introduction.md" %}
Want to know more about Open Source Community Africa? Read the following sections:

## Terminologies
{% content-ref url="about/introduction.md" %}
[introduction.md](about/introduction.md)
{% endcontent-ref %}

Read our **Terminology** page to know more about all key members of our community:
{% content-ref url="about/community-code-of-conduct.md" %}
[community-code-of-conduct.md](about/community-code-of-conduct.md)
{% endcontent-ref %}

{% page-ref page="about/terminology.md" %}
{% content-ref url="about/terminology.md" %}
[terminology.md](about/terminology.md)
{% endcontent-ref %}

## Browsing Categories

Want to know more about the Open Source Community Africa Code of Conduct? Read our **Community Code of Conduct** section:
Want to know more about Open Source Community Africa branding guidelines? Read the section below:

{% page-ref page="about/community-code-of-conduct.md" %}
{% content-ref url="about/guidelines.md" %}
[guidelines.md](about/guidelines.md)
{% endcontent-ref %}

Want to know more about Open Source Community Africa as an organization? Read our **Organization** section:
Got a question or inquiry? Read Read the section below:

Want to know more about Open Source Community Africa community guidelines? Read our **Guidelines** section:
{% content-ref url="about/faqs.md" %}
[faqs.md](about/faqs.md)
{% endcontent-ref %}

{% page-ref page="about/guidelines.md" %}
Want to know more about Open Source Community Africa team? Read the section below:

Got a question or inquiry? Read our **FAQs** section:
{% content-ref url="about/team.md" %}
[team.md](about/team.md)
{% endcontent-ref %}

{% page-ref page="about/faqs.md" %}
Want to know more about Open Source Community Africa values and processes? Read the section below:

Want to know more about Open Source Community Africa values? Read our **Values** section:
{% content-ref url="about/the-osca-way/" %}
[the-osca-way](about/the-osca-way/)
{% endcontent-ref %}

Want to know more about Open Source Community Africa team? Read our **Team** section:
Want to know more about Open Source Community Africa community? Read our **COMMUNITY** section:

{% page-ref page="about/team.md" %}
{% content-ref url="broken-reference" %}
[Broken link](broken-reference)
{% endcontent-ref %}

Want to know more about Open Source Community Africa processes? Read our **The OSCA Way** section:
Want to know more about Open Source Community Africa finance processes? Read the section below:

{% page-ref page="about/the-osca-way/" %}
{% content-ref url="broken-reference" %}
[Broken link](broken-reference)
{% endcontent-ref %}

Want to know more about Open Source Community Africa community? Read our **COMMUNITY** section:
Want to know more about Open Source Community Africa partnerships and external OSS programs? Read the section below:

Want to know more about Open Source Community Africa partnerships and external OSS programs? Read our **OSS Programs** section:
{% content-ref url="broken-reference" %}
[Broken link](broken-reference)
{% endcontent-ref %}

Want to know more about contributing to Open Source Community Africa? Read our **CONTRIBUTING** section:
Want to know more about contributing to Open Source Community Africa? Read the section below:

Want to know more about Open Source Community Africa projects? Read our **PROJECTS** section:
{% content-ref url="broken-reference" %}
[Broken link](broken-reference)
{% endcontent-ref %}

Want to know more about Open Source Community Africa finance? Read our **FINANCE** section:
Want to know more about Open Source Community Africa projects? Read the section below:

Want to know more about how to submit expenses to Open Source Community Africa? Read our **EXPENSES & GETTING PAID** section:
{% content-ref url="broken-reference" %}
[Broken link](broken-reference)
{% endcontent-ref %}

## Contact Us

If you need more help, please contact us at [[email protected]](mailto:[email protected]) or join our [Discord](https://bit.ly/osca-discord) server.

## How can I Contribute

To get started, check out the contribution guidelines for [Engineering](contributing/engineering/), [Design](contributing/design/), and [Documentation](contributing/documentation/).

## Financial Contributors

Become a financial contributor and help us sustain our community. \[[Contribute](https://opencollective.com/osca/contribute)\]
Become a financial contributor and help us sustain our community. \[[Contribute](https://opencollective.com/osca/contribute)]

### Individuals

![OSCA Financial Contributors](https://opencollective.com/osca/individuals.svg?width=900)

### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. \[[Contribute](https://opencollective.com/osca/contribute)\]
Support this project with your organization. Your logo will show up here with a link to your website. \[[Contribute](https://opencollective.com/osca/contribute)]

[![OSCA Financial Contributor](https://opencollective.com/osca/organization/0/avatar.svg)](https://opencollective.com/osca/organization/0/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/1/avatar.svg)](https://opencollective.com/osca/organization/1/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/2/avatar.svg)](https://opencollective.com/osca/organization/2/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/3/avatar.svg)](https://opencollective.com/osca/organization/3/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/4/avatar.svg)](https://opencollective.com/osca/organization/4/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/5/avatar.svg)](https://opencollective.com/osca/organization/5/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/6/avatar.svg)](https://opencollective.com/osca/organization/6/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/7/avatar.svg)](https://opencollective.com/osca/organization/7/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/8/avatar.svg)](https://opencollective.com/osca/organization/8/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/9/avatar.svg)](https://opencollective.com/osca/organization/9/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/10/avatar.svg)](https://opencollective.com/osca/organization/10/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/11/avatar.svg)](https://opencollective.com/osca/organization/11/website) [![OSCA Financial Contributor](https://opencollective.com/osca/organization/12/avatar.svg)](https://opencollective.com/osca/organization/12/website)

## Contributors ✨

Thanks goes to these wonderful people \([emoji key](https://allcontributors.org/docs/en/emoji-key)\):
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

| [![](https://avatars2.githubusercontent.com/u/30334776?v=4) **Bolaji Ayodeji**](https://bolajiayodeji.com) [📖](https://github.com/oscafrica/documentation/commits?author=BolajiAyodeji) | [![](https://avatars3.githubusercontent.com/u/30195980?v=4) **Prosper Opara**](https://kodekage.tech) [📖](https://github.com/oscafrica/documentation/commits?author=kodekage) | [![](https://avatars3.githubusercontent.com/u/6048601?v=4) **Samson Goddy**](http://samsongoddy.com) [📖](https://github.com/oscafrica/documentation/commits?author=samswag) | [![](https://avatars0.githubusercontent.com/u/13289217?v=4) **Ada Nduka Oyom**](http://medium.com/kolokodess) [📖](https://github.com/oscafrica/documentation/commits?author=Kolokodess) | [![](https://avatars0.githubusercontent.com/u/32799642?v=4) **Ogheneyoma Obomate Okobiah**](https://github.com/yomaokobiah) [📖](https://github.com/oscafrica/documentation/commits?author=yomaokobiah) | [![](https://avatars1.githubusercontent.com/u/30669761?v=4) **Peace Ojemeh**](http://peaceojemeh.com/) [📖](https://github.com/oscafrica/documentation/commits?author=perriefidelis) |
| :--- | :--- | :--- | :--- | :--- | :--- |

| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

45 changes: 21 additions & 24 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,14 @@
* [Introduction](about/introduction.md)
* [Terminology](about/terminology.md)
* [Community Code of Conduct](about/community-code-of-conduct.md)
* [Guidelines](about/guidelines.md)
* [Branding Guidelines](about/guidelines.md)
* [FAQs](about/faqs.md)
* [Team](about/team.md)
* [The OSCA Way](about/the-osca-way/README.md)
* [Values](about/the-osca-way/values.md)
* [Community Guidelines](about/the-osca-way/community-guidelines.md)
* [OSCA Governance](about/the-osca-way/governance.md)
* [Core Contributors Guidelines](about/the-osca-way/core-contributors-guidelines.md)
* [Core Contributors: Communication](about/the-osca-way/core-contributors-communication.md)
* [Core Contributors: Expenses](about/the-osca-way/core-contributors-expenses.md)
* [OSCA Governance](about/the-osca-way/governance.md)

## COMMUNITY

Expand All @@ -29,12 +27,24 @@
* [OSS Jobs](community/open-source-jobs.md)
* [Roadmap](community/roadmap.md)

## OSS Programs
## FINANCE

* [Open Collective](finance/open-collective.md)
* [Tiers & Goals](finance/tiers-and-goals.md)
* [Transparent Budget](finance/transparent-budget.md)
* [Expenses & Getting Paid](finance/expenses-and-getting-paid/README.md)
* [Expense Policy](finance/expenses-and-getting-paid/expense-policy.md)
* [Submitting Expenses](finance/expenses-and-getting-paid/submitting-expenses.md)
* [Approving Expenses](finance/expenses-and-getting-paid/approving-expenses.md)
* [Editing Expenses](finance/expenses-and-getting-paid/edit-an-expense.md)

## OSS PROGRAMS

* [OSCA Open Source Challenge](oss-programs/osca-open-source-challenge.md)
* [Hacktoberfest](oss-programs/hacktoberfest.md)
* [Google Summer of Code](oss-programs/google-summer-of-code.md)
* [Google Season of Docs](oss-programs/google-season-of-docs.md)
* [Outreachy](oss-programs/outreachy.md)
* [Hacktoberfest](oss-programs/hacktoberfest.md)

## CONTRIBUTING

Expand All @@ -47,35 +57,22 @@
* [Documentation](contributing/documentation/README.md)
* [Contribution Guidelines](contributing/documentation/guidelines.md)
* [Style Guide](contributing/documentation/style-guide.md)
* [Useful Resources](contributing/documentation/useful-resources.md)
* [Issue Labels](contributing/issue-labels.md)

## PROJECTS

* [OSCA Twitter Bot](projects/osca-twitter-bot.md)
* [OSCA Discord Bot](projects/osca-discord-bot.md)
* [Awesome Open Source](projects/osca-twitter-bot.md)
* [OSCA Community Website](projects/osca-discord-bot.md)
* [OSF Website](projects/osf-website.md)

## FINANCE

* [Open Collective](finance/open-collective.md)
* [Tiers & Goals](finance/tiers-and-goals.md)
* [Transparent Budget](finance/transparent-budget.md)
* [Expense Policy](finance/expense-policy.md)
* [Approving Expenses](finance/approving-expenses.md)
* [Events](finance/events.md)
* [OSCA Chapters Directory](projects/osca-chapters-directory.md)
* [OSCA Documentation](projects/osca-documentation.md)
* [OSCA Design](projects/osca-design.md)

## FINANCIAL CONTRIBUTORS

* [Individuals](financial-contributors/individuals.md)
* [Organizations](financial-contributors/organizations.md)

## EXPENSES & GETTING PAID

* [Submitting Expenses](expenses-and-getting-paid/submitting-expenses.md)
* [Expense Comments](expenses-and-getting-paid/expense-comments.md)
* [Edit an Expense](expenses-and-getting-paid/edit-an-expense.md)

## INTERNAL

* [Scope](internal/scope.md)
Expand Down
5 changes: 1 addition & 4 deletions about/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Introduction



![](../.gitbook/assets/nxtbc.png)

![](../.gitbook/assets/NXTBC.png)
16 changes: 7 additions & 9 deletions community/chapters/chapter-leads-onboarding-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@ description: Introductory guide to the OSCA Chapters Program for new leads and c

Our goal is to increase the rate of credible contributions by African software developers, designers, writers, and everyone involved in the sphere of technology to open source projects both locally and globally, changing Africans' perception from just the billion users to the **NEXT BILLION CREATORS**.

![](../../.gitbook/assets/nxtbc.png)
![](../../.gitbook/assets/NXTBC.png)

![](../../.gitbook/assets/52054757972\_a14c3175e6\_o.jpg)

### What does it mean to be an OSCA Chapter Lead?&#x20;
### What does it mean to be an OSCA Chapter Lead?

As an OSCA chapter lead, you represent a global network of open-source enthusiasts, and you are responsible for growing and supporting a vibrant local OSCA community in Africa.

### What does it mean to be an OSCA Chapter Co-Lead?&#x20;
### What does it mean to be an OSCA Chapter Co-Lead?

As an OSCA chapter co-lead, you represent a global network of open-source enthusiasts, and you are responsible for growing and supporting a vibrant local OSCA community in Africa alongside another co-lead(s).

### Code of Conduct

> Alone we can do so little, together we can do so much.
Kindly check out our community code of conduct below 👇🏾.&#x20;
Kindly check out our community code of conduct below 👇🏾.

{% content-ref url="../../about/community-code-of-conduct.md" %}
[community-code-of-conduct.md](../../about/community-code-of-conduct.md)
Expand All @@ -48,7 +48,7 @@ Successful leads ensure that the local community they lead embodies OSCA’s cor

#### 3️⃣ Host events and activities.

* Plan a physical or virtual event **at least once in three (3) months** to avoid being blacklisted.&#x20;
* Plan a physical or virtual event **at least once in three (3) months** to avoid being blacklisted.
* Invite local or global technical/non-technical speakers with experience in the covered topics.
* Communicate and partner with local communities, tech hubs, and influencers.
* Host any activity (meetup, webinar, workshop, hackathon, project, etc.) that supports your community's open-source education needs.
Expand All @@ -57,7 +57,7 @@ Successful leads ensure that the local community they lead embodies OSCA’s cor

* Participate in the monthly community calls with your community manager.
* If you need to take any action and you're unsure if it's acceptable, please ensure to run the idea through your community manager for approval before proceeding.
* Coordinate with the Open Source Community Africa for support in planning your event (swag, promotion, etc.).&#x20;
* Coordinate with the Open Source Community Africa for support in planning your event (swag, promotion, etc.).
* Submit event reports after every meetup/event you organize for your local community.

### Social Media
Expand Down Expand Up @@ -116,6 +116,4 @@ At Open Source Community Africa, we are transparent and manage all processes of

You will learn more about submitting expenses in the private Chapter Leads Hub.



Thank you for coming this far. We wish you all the best as you begin this new journey. Cheers! 🧡\
Thank you for coming this far. We wish you all the best as you begin this new journey. Cheers! 🧡\\
2 changes: 2 additions & 0 deletions finance/expenses-and-getting-paid/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Expenses & Getting Paid

2 changes: 2 additions & 0 deletions finance/expenses-and-getting-paid/approving-expenses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Approving Expenses

2 changes: 2 additions & 0 deletions finance/expenses-and-getting-paid/edit-an-expense.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Edit an Expense

2 changes: 2 additions & 0 deletions finance/expenses-and-getting-paid/expense-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Expense Policy

2 changes: 2 additions & 0 deletions finance/expenses-and-getting-paid/submitting-expenses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Submitting Expenses

2 changes: 2 additions & 0 deletions oss-programs/osca-open-source-challenge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# OSCA Open Source Challenge

2 changes: 2 additions & 0 deletions projects/osca-chapters-directory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# OSCA Chapters Directory

2 changes: 2 additions & 0 deletions projects/osca-design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# OSCA Design

2 changes: 2 additions & 0 deletions projects/osca-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# OSCA Documentation

0 comments on commit eaac4f3

Please sign in to comment.