Skip to content

Commit

Permalink
Inital Commit
Browse files Browse the repository at this point in the history
Signed-off-by: Vipul Gupta (@vipulgupta2048) <[email protected]>
  • Loading branch information
vipulgupta2048 committed Oct 13, 2020
0 parents commit 5d9720a
Show file tree
Hide file tree
Showing 4 changed files with 135 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* text=auto
readme.md merge=union
1 change: 1 addition & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<p xmlns:dct="http://purl.org/dc/terms/" xmlns:cc="http://creativecommons.org/ns#" class="license-text"><a rel="cc:attributionURL" property="dct:title" href="https://github.com/vipulgupta2048/awesome-documentation">Awesome Documentation</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://twitter.com/vipulgupta2048">Vipul Gupta</a> is licensed under <a rel="license" href="https://creativecommons.org/licenses/by-nd/4.0">CC BY-ND 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" /><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" /><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nd.svg?ref=chooser-v1" /></a></p>
74 changes: 74 additions & 0 deletions code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
58 changes: 58 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Awesome Documentation [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)

> A curated list of awesome real-life documentation examples

## About

Once upon a time, I set out to find and share great examples of technical documentation over the web. But, couldn't find a single awesome community curated resouce containing great documentation examples that were categoried as per their usecases. Well, that's how this awesome list came along. Be sure to add even more documentation websites that you see all over the web.

Each heading in the list and links below it relates a section of the documentation that is equal parts captivating, interesting and inspiring. If code for the repository is open-source, it would be linked right next to it. Below you can find, table of contents.

> TODO: Add a table of contents
---

## Getting Started

- [Django Getting Started](https://www.djangoproject.com/start/) - https://github.com/django/django/tree/master/docs
- [balena Getting Started](https://www.balena.io/docs/learn/getting-started/raspberrypi3/nodejs/) - https://github.com/balena-io/docs
- [Docker Getting Started](https://docs.docker.com/get-started/) - https://github.com/docker/docker.github.io/

## Tutorials && Guides

- [Gatsby Tutorials](https://www.gatsbyjs.com/tutorial/)
- [DigitalOcean Tutorials](https://www.digitalocean.com/community/tutorials)
- [Twilio Guides](https://www.twilio.com/docs/whatsapp/tutorial/send-whatsapp-notification-messages-templates)

## References

- [Docker References](https://docs.docker.com/reference/)

## Cookbooks


## API/SDK

- [Stripe API Reference](https://stripe.com/docs/api)

## Neat ways of versioning the docs

- [GitHub docs](https://docs.github.com/en/free-pro-team@latest/github) - [Github Repository](https://github.com/github/docs)

## CLI

- [Click](https://click.palletsprojects.com/en/7.x/)
- [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli)

## Enterprise

## Great Discoverablity in Docs

## Focus on Accessiblity (a11y)

## Focus on Internationalization (i18n)

## Changelog

## Patterns & Best Practices

0 comments on commit 5d9720a

Please sign in to comment.