diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..9bae4a71 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ + + +#### What Type of Change is this? + +- [ ] New Page +- [ ] Minor Fix +- [ ] Major Improvement + +#### Description (required) + + + +#### Related issues & labels (optional) + +- Closes # + + + + + + diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 00000000..fc33430d --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,28 @@ +name: Build + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + Build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Node.js 18 + uses: actions/setup-node@v3 + with: + node-version: '18' + + - name: Install Dependencies + run: yarn install --frozen-lockfile + + - name: Build + run: yarn build + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..295bf28e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,16 @@ +## 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8302c4b..5ac98f9a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,71 @@ -```sh -yarn -``` +# Contributing to Zerops Docs -```sh -yarn dev -``` +We're excited you're interested in contributing to our Turborepo-based Docusaurus documentation! This guide will help you get started. + +## Prerequisites + +- [Node.js](https://nodejs.org/en/) (version 18 or above) +- [Yarn](https://yarnpkg.com/) package manager + +## Project Structure + +This project uses Turborepo to manage a monorepo structure. The documentation site is likely one of the workspaces within this structure. + +## Getting Started + +1. Fork the repository +2. Clone your fork: `git clone https://github.com/your-username/repo-name.git` +3. Navigate to the project directory: `cd repo-name` +4. Install dependencies: `yarn` +5. Create a new branch: `git checkout -b your-branch-name` + +## Running the Site Locally + +1. Start the development server: `yarn dev` + This command uses Turborepo to run the dev script in the documentation workspace. +2. Open your browser and visit `http://localhost:3001`. + +## Making Changes + +1. Make your changes in the appropriate workspace (likely in the `docs` or similar directory) +2. Test your changes locally using the development server +3. Run `yarn build` to ensure your changes don't cause build errors across the monorepo +4. Commit your changes: `git commit -m "Your descriptive commit message"` +5. Push to your fork: `git push origin your-branch-name` + +## Submitting a Pull Request + +1. Go to the original repository on GitHub +2. Click the "New pull request" button +3. Select your fork and the branch containing your changes +4. Fill out the pull request template with details about your changes +5. Submit the pull request + +## Other Commands + +- `yarn build`: Builds all workspaces in the monorepo +- `yarn lint`: Runs linting across all workspaces +- `yarn test`: Runs tests across all workspaces (if configured) + +Check for more scripts in `package.json`. + +Refer to the `turbo.json` file in the root of the repository for more details on the configured pipelines. + +## Style Guide + +- Use Markdown for all documentation files in the docs workspace +- Follow the [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features) guide +- Use sentence case for headings +- Keep line length to a maximum of 80 characters +- Use American English spelling +- Adapt to our pattern + +## Code of Conduct + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. + +## Need Help? + +If you have any questions or need help with your contribution, please open an issue or reach out to the maintainers. + +Thank you for contributing to [Repository Name]! diff --git a/README.md b/README.md index 6ca24da3..6309a94a 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,42 @@ -# Zerops Documentation -https://docs.zerops.io +![Docs cover](https://github.com/zeropsio/recipe-shared-assets/blob/main/covers/svg/cover-docs.svg) + +
+ + Twitter + • + Discord Server + • + LinkedIn + +
+ +
+Made with ❤️ for Documentation lovers.
+
+