Giter Club home page Giter Club logo

saintmalik / awesome-oss-docs Goto Github PK

View Code? Open in Web Editor NEW
107.0 5.0 62.0 50.69 MB

๐Ÿ“š A curated list of awesome open source documentation for people whole love contributing to docs (Documentarians).

Home Page: https://awesome-oss-docs.vercel.app

License: Creative Commons Zero v1.0 Universal

Go 0.61% HTML 13.61% JavaScript 85.62% CSS 0.16%
awesome-list awesome documentation opensource open-source oss hacktoberfest hacktoberfest-2023

awesome-oss-docs's Introduction

+ ๐Ÿ‘‹๏ธ๐Ÿ‘‹๏ธ Hello there

I'm an application security engineer ๐Ÿ”“๏ธ -- but also I work on:

devsecops ๐Ÿ—๏ธ, clis/web apis with Go ๐Ÿ–ฅ๏ธ, pentesting ๐Ÿ› ๏ธ and jankops ๐Ÿ”จ๏ธ

currently working with Go and in AppSec, while improving my SecOps skill set. โšก๏ธ

Technologies

Linux Docker Kubernetes Terraform AWS OpenTofu

awesome-oss-docs's People

Contributors

1amsammi3 avatar ariyoaresa avatar captain-tee01 avatar chaos10001 avatar danielagbeni avatar elijah699 avatar favour-dgreat avatar harshitrajsinha avatar harshleey avatar ilyaspiridonov avatar juzhiyuan avatar kinz1 avatar mastertime avatar medha-ab avatar menorahh avatar nobledeveloper01 avatar ogunmisim avatar olusure avatar onifaithayoola avatar osca-ado-ekiti avatar paul-annay avatar petsamuel avatar saintmalik avatar shazm12 avatar shivanisarthi avatar sproff avatar taran1326 avatar tuasegun avatar virtual4087 avatar wonderful-coyote avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

awesome-oss-docs's Issues

Add the filter categories for all SUSE, Tailwind, The Guild documentations

Research on each documentation in the SUSE, Tailwind and The Guild section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Create amazon.js file and add all Amazon docs in the README.md to the file

  1. Follow this structure to know where you will create your file:

awesome-oss-docs/awesome-oss-docs/src/constants/docs/orderByAlphabet

  1. Add all amazon docs to the file you created,. Each docs are added in this format:

{
title: 'Airflow Docs',
description:
'A platform to programmatically author, schedule, and monitor workflows.',
projectUrl: 'https://airflow.incubator.apache.org/docs/',
githubUrl: 'https://github.com/apache/airflow/tree/main/docs',
owner: 'Community Owned Documentation',
},

For better insight of how the file should look like check out the Apache File

  1. After adding all docs, Go to the index.js file in the docs folder, create an import of the file you added and put the name in the export default array

Add the filter categories for all Airbnb and Amazon documentations

Research on each documentation in the Airbnb and Amazon section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Dropbox Active OSS Docs

Please find any Active Open Source Project owned by Dropbox that has documentation page which still accepts contributions.

Create bridgecrew.js file and add all bridgecrew docs in the README.md to the file

  1. Follow this structure to know where you will create your file:

awesome-oss-docs/awesome-oss-docs/src/constants/docs/orderByAlphabet

  1. Add all bridgecrew docs to the file you created,. Each docs are added in this format:

{
title: 'Airflow Docs',
description:
'A platform to programmatically author, schedule, and monitor workflows.',
projectUrl: 'https://airflow.incubator.apache.org/docs/',
githubUrl: 'https://github.com/apache/airflow/tree/main/docs',
owner: 'Community Owned Documentation',
},

For better insight of how the file should look like check out the Apache File

  1. After adding all docs, Go to the index.js file in the docs folder, create an import of the file you added and put the name in the export default array

Add Active Confluent Inc OSS Docs

Please find any active Confluent Inc Open Source Projects that has documentation page which still accepts contributions.

Your job is to find the active OSS project that has documentations and accept contribution.

Add the filter categories for all Letter D & E documentations

Research on each documentation in the Letter D & E section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

More Facebook Active OSS Docs

Please find any new Active Open Source Project owned by Facebook that has documentation page which still accepts contributions.

Create apple.js file and add all apple docs in the README.md to the file

  1. Follow this structure to know where you will create your file:

awesome-oss-docs/awesome-oss-docs/src/constants/docs/orderByAlphabet

  1. Add all Apple docs to the file you created,. Each docs are added in this format:

{
title: 'Airflow Docs',
description:
'A platform to programmatically author, schedule, and monitor workflows.',
projectUrl: 'https://airflow.incubator.apache.org/docs/',
githubUrl: 'https://github.com/apache/airflow/tree/main/docs',
owner: 'Community Owned Documentation',
},

For better insight of how the file should look like check out the Apache File

  1. After adding all docs, Go to the index.js file in the docs folder, create an import of the file you added and put the name in the export default array

Add the filter categories for all Letter G documentations

Research on each documentation in the Letter G section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Split company-supported OSS projects from community ones

I would love to see a section dedicated to indie/community projects, since those are likely those that need documentation contributors the most, and people looking for open source projects to contribute docs to might want to look at those specifically. I know I would :)

Additionally, maybe we could also consider dividing the large projects into those that are supported by for-profit corporations, and those that are backed by organizations, non-profits and foundations focused on the open source model, e.g. Apache, RedHat, Mozilla, Wikimedia, Linux, etc.

Apple Active OSS Docs

Please find any Active Open Source Project owned by Apple that has documentation page which still accepts contributions.

Puppet Active OSS Docs

Please find any Active Open Source Project owned by Puppet that has documentation page which still accepts contributions.

You can check here: https://puppet.com/open-source/

Your job is to find the active OSS project that has documentations and accept contribution.

Add Active Intel Corporation OSS Docs

Please find any active Intel Corporation Open Source Projects that has documentation page which still accepts contributions.

Your job is to find the active Intel Corporation OSS project that has documentations and accept contribution.

Add the filter categories for all Facebook documentations

Research on each documentation in the Twilio, Twitter and Upbound section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Add the filter categories for all Samsung, Shopify, and SlackHQ documentations

Research on each documentation in the Samsung, Shopify, and SlackHQ section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Add the filter categories for Confluent and Cryptocurrencies documentations

Research on each documentation in the Confluent and Cryptocurrencies section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Add the filter categories for all Uber documentations

Research on each documentation in the Uber section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Workflow: Write the linting workflow

Hello there, here is an issue to write the github workflow that checks the code to see if it follows the laid down rules, hence on every pull request it runs the linting check. e.g husky and prettier setup

Add the filter categories for all Letter H, I, and J documentations

Research on each documentation in the Letter H, I , and J section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Add the filter categories for all Letter N and O documentations

Research on each documentation in the Letter N and O section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Elastic Active OSS Docs

Please find any Active Open Source Project owned by Elastic that has documentation page which still accepts contributions.

You can check here: https://github.com/elastic

Your job is to find the active OSS project that has documentations and accept contribution.

Add the filter categories for all Twilio, Twitter and Upbound documentations

Research on each documentation in the Twilio, Twitter and Upbound section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Add Active loginradius OSS Docs

Please find any active loginradius Open Source Projects that has documentation page which still accepts contributions.

Your job is to find the active OSS project that has documentations and accept contribution.

Add a community guidelines readme

Hi.
I want to contribute to this awesome project by creating a readme file that states community guidelines to enlighten people on how to behave while working on the project.

It's an important thing to have when working with a lot of people.
Shall I get started ๐Ÿ™‚

Add More Active MayaData OSS Docs

Please find any active MayaData Open Source Projects that has documentation page which still accepts contributions.

Your job is to find the active MayaData OSS project that has documentations and accept contribution.

Add the filter categories for Apache, Apple and Bridgecrew documentations

Research on each documentation in the Apache. Apple and Bridgecrew section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Add the filter categories for all Microsoft documentations

Research on each documentation in the Microsoft section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Add the filter categories for all Letter P, R and Saleforce documentations

Research on each documentation in the Letter P, R and Saleforce section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Add the filter categories for all Letter F documentations

Research on each documentation in the Letter F section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Add the filter categories for all Letter L and MayaData documentations

Research on each documentation in the Letter L and MayaData section to filter them into Company Owned Documentation and Community Owned Documentation

After getting your answer, add the category like this in the README.md file at the front of the documentation wrapped in backticks ``

e.g.

  • Amazon S3 Docs - Amazon Simple Storage Service (Amazon S3) is storage for the internet. You can use Amazon S3 to store and retrieve any amount of data at any time, from anywhere on the web. - Company Owned Documentation

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.