diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..eac8807 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,5 @@ +# Rule for markdown files +*.md @ionut-arm @hug-dev + +# Rule for GitHub-specific files +.github/* @ionut-arm @hug-dev \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..ce008ec --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,23 @@ +name: Build Github mdBook + +on: + push: + branches: + - master + +jobs: + deploy: + runs-on: ubuntu-18.04 + steps: + - uses: actions/checkout@v1 + - name: Install mdbook + run: cargo install mdbook + - name: Build book + run: mdbook build + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v2 + env: + ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }} + PUBLISH_BRANCH: gh-pages + PUBLISH_DIR: ./book diff --git a/.gitignore b/.gitignore index 7585238..0b2d38e 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ book +*patch +*DS_Store diff --git a/src/dev_guides/README.md b/src/dev_guides/README.md index e69de29..6234f2a 100644 --- a/src/dev_guides/README.md +++ b/src/dev_guides/README.md @@ -0,0 +1,25 @@ + + +# Developer guides + +These notes are meant as a guide for those looking to work hands-on with the Parsec service source code. They cover the following concepts: + +* [Building](build.md) - description of the options that can be used for building the service and how they relate to the build environment +* [Testing](test.md) - details about the kinds of tests we employ and how to set up your environment in preparation for running them +* [Writing a client](writing_library.md) - guide for implementing a new client library +* [Writing a provider](adding_provider.md) - guide for implementing a new provider that will add Parsec support for new platforms \ No newline at end of file diff --git a/src/dev_guides/adding_provider.md b/src/dev_guides/adding_provider.md index 496b370..0841c58 100644 --- a/src/dev_guides/adding_provider.md +++ b/src/dev_guides/adding_provider.md @@ -1,5 +1,5 @@