Skip to content

Commit

Permalink
Added docs to monorepo
Browse files Browse the repository at this point in the history
  • Loading branch information
scopsy committed Sep 23, 2021
1 parent c26daad commit 466d778
Show file tree
Hide file tree
Showing 46 changed files with 10,588 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
21 changes: 21 additions & 0 deletions docs/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Dima Grossman

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
33 changes: 33 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

```
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions docs/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
4 changes: 4 additions & 0 deletions docs/docs/community/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Community",
"position": 5
}
80 changes: 80 additions & 0 deletions docs/docs/community/code-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
sidebar_position: 6
---

# 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, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
165 changes: 165 additions & 0 deletions docs/docs/community/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
---
sidebar_position: 3
---

# Contributing

How to help us help you :) Notifire is an Open Source project, we would love for you to contribute,
you can see here our guidelines, making sure our code base is [readable](https://en.wikipedia.org/wiki/Code_Reading).

- [Questions](#question)
- [Issues and Bugs](#issue)
- [Feature Requests](#feature)
- [Missing Provider](#provider)
- [Submission Guidelines](#submit)
- [Development Setup](#development)
- [Coding Rules](#rules)

Other than code contribution you can also help us with efforts.
- [Answer Discussions][github-discussions].
- Try our [providers][providers-list] and give feedback.
- Spread the word if you like what we are doing.


## <a name="question"></a> Got a Question or a Thought?

The best place to reach us about questions, problems, or thoughts is on our [GitHub Discussions][github-discussions] page.
There you both find previous discussions were we already started talking about that, or you can create a new discussion, your very own discussion.

## <a name="issue"></a> Found a Bug?

While we do have Unit tests, and process to verify PR's bugs still exists, if you find a bug, you can help us by
[submitting an issue](#submit-issue) to our [GitHub Issues][github-issues]. Or you can
[submit a Pull Request](#submit-pr) with a fix.

## <a name="feature"></a> Missing a Feature?

If a feature is missing you can _request_ a new one by [submitting an issue](#submit-issue) to our GitHub
Repository. In the case you would like to _implement_ it, an issue with a proposal must be submitted first, to be sure that we can use it.
Please consider:

- **Small Feature** can be submitted directly to [submitted as a Pull Request](#submit-pr) after the implementation.
- **Major Feature** proposal needs to be discussed first, so open a discussion in our [GitHub Discussions][github-discussions].
This will also allow us to prevent duplication of work, coordinate our efforts better, and ultimately build it so that it is successfully merged into the Notifire.


## <a name="provider"></a> Missing a Provider?

If a provider is missing you can _request_ a new one by [submitting an issue](#submit-issue) to our GitHub
Repository. Or you can build a new one, following our [create a provider](create-provider.md) article.

## <a name="submit"></a> Submission Guidelines

### <a name="submit-issue"></a> Submitting an Issue

Prior of a new issue submission, please search the [issues tab][github-issues], and [discussion tab][github-discussions] maybe an issue or discussion already exists and the discussion might inform you of workarounds, or you can give new information.

While we want to fix all the issues, before fixing a bug we need to be able to reproduce and confirm it.
Please provide us with a minimal reproduction scenario using a repository or [Gist](https://gist.github.com/). Having a live, reproducible scenario gives us the information without asking questions back & forth with additional questions like:

- 3rd-party libraries and their versions, mainly providers, but not exclusively
- a use-case that fails

Without said minimal reproduction, we won't be able to investigate all issues, and the issue might not be resolved.

You can open a new issues with this [new issue form](https://github.com/notifirehq/notifire/issues/new).

### <a name="submit-pr"></a> Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

1. Look in our [GitHub](https://github.com/notifirehq/notifire/pulls) for an open or closed PR
that relates to your submission. You don't want to duplicate effort.
1. Fork notifirehq/notifire repo, or any of our providers.
1. Make your changes in a new git branch:

```shell
git checkout -b my-new-branch master
```

1. Write your code, **including test cases**.
1. Follow our [Coding Rules](#rules).
1. Run the full test suit (see [common scripts](#common-scripts)),
and ensure that all tests pass.
1. Commit your changes using a descriptive commit message that follows our
[commit message conventions](#commit). Adherence to these conventions
is necessary because release notes are automatically generated from these messages.

```shell
git commit -a
```

Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.

1. Push your branch to GitHub:

```shell
git push origin my-new-branch
```

1. In GitHub, send a pull request to `notifire:master`.

- If we suggest changes then:

- Make the required updates.
- Re-run the test suite to ensure tests are still passing.
- Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

```shell
git rebase master -i
git push -f
```

That's it! You are amazing! Thank you for your contribution!
#### After your pull request is merged
After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:
- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```shell
git push origin --delete my-new-branch
```
- Check out the master branch:
```shell
git checkout master -f
```
- Delete the local branch:
```shell
git branch -D my-new-branch
```
- Update your master with the latest upstream version:
```shell
git pull --ff upstream master
```
## <a name="development"></a> Development Setup
Will be added shortly.
### <a name="common-scripts"></a>Commonly used NPM scripts
Will be added shortly.
## <a name="rules"></a> Coding Rules
To ensure consistency throughout the source code, keep these rules in mind as you are working:
- All features or bug fixes **must be tested** by one or more specs (unit-tests).
- We use [Eslint default rule guide][js-style-guide], with minor changes.
An automated formatter is available (`npm run format`).
Documentation is inspired by [nestjs](https://github.com/nestjs/nest) and [supabase](https://github.com/supabase/supabase)
[github-issues]: https://github.com/notifirehq/notifire/issues
[github-discussions]: https://github.com/notifirehq/notifire/discussions
[js-style-guide]: https://eslint.org/docs/rules/
[providers-list]: https://www.notifire.co/providers-list
Loading

0 comments on commit 466d778

Please sign in to comment.