-
-
Notifications
You must be signed in to change notification settings - Fork 6
Improved docs #21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
hvitis
wants to merge
5
commits into
tarsil:master
Choose a base branch
from
hvitis:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Improved docs #21
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -13,7 +13,6 @@ develop-eggs/ | |
| dist/ | ||
| docs/_build/ | ||
| eggs/ | ||
| lib/ | ||
| lib64/ | ||
| parts/ | ||
| sdist/ | ||
|
|
||
This file contains hidden or 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,12 @@ | ||
| .git/ | ||
| .github/ | ||
| build/ | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| deploy.sh | ||
| font-selection.json | ||
| README.md | ||
| Vagrantfile | ||
This file contains hidden or 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,18 @@ | ||
| # EditorConfig is awesome: https://EditorConfig.org | ||
|
|
||
| # Top-most EditorConfig file | ||
| root = true | ||
|
|
||
| # Unix-style newlines with a newline ending every file | ||
| [*] | ||
| end_of_line = lf | ||
| insert_final_newline = true | ||
| indent_style = space | ||
| indent_size = 2 | ||
| trim_trailing_whitespace = true | ||
|
|
||
| [*.rb] | ||
| charset = utf-8 | ||
|
|
||
| [*.md] | ||
| trim_trailing_whitespace = false |
This file contains hidden or 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 @@ | ||
| source/javascripts/lib/* linguist-vendored |
This file contains hidden or 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,22 @@ | ||
| --- | ||
| name: Report a Bug | ||
| about: Create a report to help us improve | ||
hvitis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| title: '' | ||
| labels: '' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **Bug Description** | ||
| A clear and concise description of what the bug is and how to reproduce it. | ||
|
|
||
| **Screenshots** | ||
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| **Browser (please complete the following information):** | ||
| - OS: [e.g. iOS] | ||
| - Browser [e.g. chrome, safari] | ||
| - Version [e.g. 22] | ||
|
|
||
| **Last upstream Slate commit (run `git log --author="\(Robert Lord\)\|\(Matthew Peveler\)\|\(Mike Ralphson\)" | head -n 1`):** | ||
| Put the commit hash here | ||
This file contains hidden or 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,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Questions, Ideas, Discussions | ||
| url: https://github.com/slatedocs/slate/discussions | ||
| about: Ask and answer questions, and propose new features. |
This file contains hidden or 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,5 @@ | ||
| <!-- | ||
| ⚠️ 🚨 ⚠️ STOP AND READ THIS ⚠️ 🚨 ⚠️ | ||
|
|
||
| 👆👆 see that 'base fork' dropdown above? You should change it! The default value of "slatedocs/slate" submits your change to ALL USERS OF SLATE, not just your company. This is PROBABLY NOT WHAT YOU WANT. | ||
| --> | ||
hvitis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or 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,9 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: bundler | ||
| directory: "/" | ||
| schedule: | ||
| interval: daily | ||
| open-pull-requests-limit: 10 | ||
| target-branch: dev | ||
| versioning-strategy: increase-if-necessary |
This file contains hidden or 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,42 @@ | ||
| name: Build | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ '*' ] | ||
| pull_request: | ||
| branches: [ '*' ] | ||
|
|
||
| jobs: | ||
| test: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| matrix: | ||
| ruby-version: [2.6, 2.7, '3.0', 3.1] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Set up Ruby | ||
| uses: ruby/setup-ruby@v1 | ||
| with: | ||
| ruby-version: ${{ matrix.ruby-version }} | ||
|
|
||
| - uses: actions/cache@v2 | ||
| with: | ||
| path: vendor/bundle | ||
| key: gems-${{ runner.os }}-${{ matrix.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }} | ||
| restore-keys: | | ||
| gems-${{ runner.os }}-${{ matrix.ruby-version }}- | ||
| gems-${{ runner.os }}- | ||
|
|
||
| # necessary to get ruby 2.3 to work nicely with bundler vendor/bundle cache | ||
| # can remove once ruby 2.3 is no longer supported | ||
| - run: gem update --system | ||
|
|
||
| - run: bundle config set deployment 'true' | ||
| - name: bundle install | ||
| run: | | ||
| bundle config path vendor/bundle | ||
| bundle install --jobs 4 --retry 3 | ||
|
|
||
| - run: bundle exec middleman build |
This file contains hidden or 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,44 @@ | ||
| name: Deploy | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ 'main' ] | ||
|
|
||
| jobs: | ||
| deploy: | ||
| permissions: | ||
| contents: write | ||
|
|
||
| runs-on: ubuntu-latest | ||
| env: | ||
| ruby-version: 2.6 | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Set up Ruby | ||
| uses: ruby/setup-ruby@v1 | ||
| with: | ||
| ruby-version: ${{ env.ruby-version }} | ||
|
|
||
| - uses: actions/cache@v2 | ||
| with: | ||
| path: vendor/bundle | ||
| key: gems-${{ runner.os }}-${{ env.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }} | ||
| restore-keys: | | ||
| gems-${{ runner.os }}-${{ env.ruby-version }}- | ||
| gems-${{ runner.os }}- | ||
|
|
||
| - run: bundle config set deployment 'true' | ||
| - name: bundle install | ||
| run: | | ||
| bundle config path vendor/bundle | ||
| bundle install --jobs 4 --retry 3 | ||
|
|
||
| - run: bundle exec middleman build | ||
|
|
||
| - name: Deploy | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./build | ||
| keep_files: true |
This file contains hidden or 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,85 @@ | ||
| name: Dev Deploy | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ 'dev' ] | ||
|
|
||
| jobs: | ||
| push_to_registry: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Check out the repo | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Set up QEMU | ||
| uses: docker/setup-qemu-action@v1 | ||
| with: | ||
| platforms: all | ||
|
|
||
| - name: Docker meta | ||
| id: meta | ||
| uses: docker/metadata-action@v3 | ||
| with: | ||
| images: | | ||
| slatedocs/slate | ||
| tags: | | ||
| type=ref,event=branch | ||
|
|
||
| - name: Set up Docker Buildx | ||
| id: buildx | ||
| uses: docker/setup-buildx-action@v1 | ||
|
|
||
| - name: Login to DockerHub | ||
| uses: docker/login-action@v1 | ||
| with: | ||
| username: ${{ secrets.DOCKER_USERNAME }} | ||
| password: ${{ secrets.DOCKER_ACCESS_KEY }} | ||
|
|
||
| - name: Push to Docker Hub | ||
| uses: docker/build-push-action@v2 | ||
| with: | ||
| builder: ${{ steps.buildx.outputs.name }} | ||
| context: . | ||
| file: ./Dockerfile | ||
| platforms: linux/amd64,linux/arm64,linux/ppc64le | ||
| push: true | ||
| tags: ${{ steps.meta.outputs.tags }} | ||
| labels: ${{ steps.meta.outputs.labels }} | ||
|
|
||
| deploy_gh: | ||
| permissions: | ||
| contents: write | ||
|
|
||
| runs-on: ubuntu-latest | ||
| env: | ||
| ruby-version: 2.6 | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Set up Ruby | ||
| uses: ruby/setup-ruby@v1 | ||
| with: | ||
| ruby-version: ${{ env.ruby-version }} | ||
|
|
||
| - uses: actions/cache@v2 | ||
| with: | ||
| path: vendor/bundle | ||
| key: gems-${{ runner.os }}-${{ env.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }} | ||
| restore-keys: | | ||
| gems-${{ runner.os }}-${{ env.ruby-version }}- | ||
| gems-${{ runner.os }}- | ||
| - run: bundle config set deployment 'true' | ||
| - name: bundle install | ||
| run: | | ||
| bundle config path vendor/bundle | ||
| bundle install --jobs 4 --retry 3 | ||
| - run: bundle exec middleman build | ||
|
|
||
| - name: Deploy | ||
| uses: peaceiris/actions-gh-pages@v3.7.0-8 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| destination_dir: dev | ||
| publish_dir: ./build | ||
| keep_files: true |
This file contains hidden or 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,47 @@ | ||
| name: Publish Docker image | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
|
|
||
| jobs: | ||
| push_to_registry: | ||
| name: Push Docker image to Docker Hub | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out the repo | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Set up QEMU | ||
| uses: docker/setup-qemu-action@v1 | ||
| with: | ||
| platforms: all | ||
|
|
||
| - name: Docker meta | ||
| id: meta | ||
| uses: docker/metadata-action@v3 | ||
| with: | ||
| images: slatedocs/slate | ||
| tags: | | ||
| type=ref,event=tag | ||
|
|
||
| - name: Set up Docker Buildx | ||
| id: buildx | ||
| uses: docker/setup-buildx-action@v1 | ||
|
|
||
| - name: Login to DockerHub | ||
| uses: docker/login-action@v1 | ||
| with: | ||
| username: ${{ secrets.DOCKER_USERNAME }} | ||
| password: ${{ secrets.DOCKER_ACCESS_KEY }} | ||
|
|
||
| - name: Push to Docker Hub | ||
| uses: docker/build-push-action@v2 | ||
| with: | ||
| builder: ${{ steps.buildx.outputs.name }} | ||
| context: . | ||
| file: ./Dockerfile | ||
| platforms: linux/amd64,linux/arm64,linux/ppc64le | ||
| push: true | ||
| tags: ${{ steps.meta.outputs.tags }} | ||
| labels: ${{ steps.meta.outputs.labels }} |
This file contains hidden or 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,29 @@ | ||
| *.gem | ||
| *.rbc | ||
| .bundle | ||
| .config | ||
| coverage | ||
| InstalledFiles | ||
| lib/bundler/man | ||
| pkg | ||
| rdoc | ||
| spec/reports | ||
| test/tmp | ||
| test/version_tmp | ||
| tmp | ||
| *.DS_STORE | ||
| build/ | ||
| .cache | ||
| .vagrant | ||
| .sass-cache | ||
| .env | ||
| build/ | ||
|
|
||
| # YARD artifacts | ||
| .yardoc | ||
| _yardoc | ||
| doc/ | ||
| .idea/ | ||
|
|
||
| # Vagrant artifacts | ||
| ubuntu-*-console.log |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.