-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #123 from jamezp/doc-update
Update documentation page and add gRPC documentation
- Loading branch information
Showing
8 changed files
with
1,551 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| name: Deploy Jekyll site to Pages | ||
|
|
||
| on: | ||
| # Runs on pushes targeting the default branch | ||
| push: | ||
| branches: ["main"] | ||
|
|
||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
|
|
||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| # Build job | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| - name: Setup Ruby | ||
| uses: ruby/setup-ruby@v1 | ||
| with: | ||
| ruby-version: '3.1' | ||
| bundler-cache: true # runs 'bundle install' and caches installed gems automatically | ||
| cache-version: 0 # Increment this number if you need to re-download cached gems | ||
| - name: Setup Pages | ||
| id: pages | ||
| uses: actions/configure-pages@v3 | ||
| - name: Build with Jekyll | ||
| # Outputs to the './_site' directory by default | ||
| run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" | ||
| env: | ||
| JEKYLL_ENV: production | ||
| - name: Upload artifact | ||
| # Automatically uploads an artifact from the './_site' directory by default | ||
| uses: actions/upload-pages-artifact@v1 | ||
|
|
||
| # Deployment job | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| - group: 1.x | ||
| supported: true | ||
| detail: | ||
| - version: 1.0.0.Alpha1 | ||
| date: 2023-05-20 | ||
| license: ASL v2 | ||
| source: https://github.com/resteasy/resteasy-grpc/archive/refs/tags/1.0.0.Alpha1.zip | ||
| release_notes: https://github.com/resteasy/resteasy-grpc/releases/tag/1.0.0.Alpha1 | ||
| documentation: | ||
| link: /docs/grpc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| layout: default | ||
| title: Documentation | ||
| selflink: docs | ||
| permalink: /docs/ | ||
| --- | ||
| <h3>RESTEasy Documentation (Latest)</h3> | ||
|
|
||
|
|
||
| <div class="release-container" id="documentation"> | ||
| {% for release in site.data.releases %} | ||
| {% if release.supported %} | ||
| {% assign detail = release.detail[0] %} | ||
| <div class="release"> | ||
| <div class="release-body"> | ||
| <h4 class="release-title">RESTEasy {{ detail.version }} <small>({{ detail.date }})</small></h4> | ||
| {% if detail.jakarta_rest_spec %} | ||
| <div class="spec"> | ||
| <strong>Implements</strong> <a href="{{ detail.jakarta_rest_spec.link }}" target="_blank">Jakarta REST {{ detail.jakarta_rest_spec.version }}</a> | ||
| <span><a href="{{ detail.jakarta_rest_spec.java_doc }}" target="_blank">(JavaDoc)</a> </span> | ||
| </div> | ||
| {% endif %} | ||
| <ul> | ||
| {% if detail.documentation.link %} | ||
| <li><a href="{{ detail.documentation.link }}" target="_blank">Documentation</a></li> | ||
| {% endif %} | ||
| {% if detail.download_link %} | ||
| <li><a href="{{ detail.download_link }}" target="_blank">Download</a></li> | ||
| {% endif %} | ||
| {% if detail.release_notes %} | ||
| <li><a href="{{ detail.release_notes }}" target="_blank">Release Notes</a></li> | ||
| {% endif %} | ||
| </ul> | ||
| </div> | ||
| <div> | ||
| <a href="{{ site.baseurl }}{% link docs/all-docs.md %}#{{ detail.version | replace:'.','' }}">Older Releases</a> | ||
| </div> | ||
| </div> | ||
| {% endif %} | ||
| {% endfor %} | ||
| {% for release in site.data.grpc.releases %} | ||
| {% if release.supported %} | ||
| {% assign detail = release.detail[0] %} | ||
| <div class="release"> | ||
| <div class="release-body"> | ||
| <h4 class="release-title">RESTEasy gRPC {{ detail.version }} <small>({{ detail.date }})</small></h4> | ||
| <ul> | ||
| <li><a href="{{ site.baseurl }}{{ detail.documentation.link }}">Documentation</a></li> | ||
| {% if detail.download_link %} | ||
| <li><a href="{{ detail.download_link }}">Download</a></li> | ||
| {% endif %} | ||
| {% if detail.release_notes %} | ||
| <li><a href="{{ detail.release_notes }}">Release Notes</a></li> | ||
| {% endif %} | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| {% endif %} | ||
| {% endfor %} | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| layout: doc-listing | ||
| title: Documentation | ||
| permalink: /docs/ | ||
| permalink: /docs/all/ | ||
| --- |
Oops, something went wrong.