Skip to content

Commit

Permalink
Add details on how to contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
DogmaDragon committed Dec 4, 2022
1 parent 7c6dae8 commit 8e6216d
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 2 deletions.
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing

## Contributing from the site via `Edit this page on GitHub`

1. On the bottom of every page you will find a link `Edit this page on GitHub`.
2. Cliking on it will open GitHub where you will be met with a message about not being able to edit directly.
3. Click `Fork this repository`.
4. You should see the text editor now.
5. Make the changes to the page you want and scroll to the bottom.
6. Add a short comment to explains your changes and click `Propose changes`.
7. Next page might look complicated, but all you need to do next is click `Create pull request`.
8. Here you can adjust the title and/or add extra comment and then click `Create pull request`.
9. That's it!

## Contributing directly from the repository

1. Go to the `docs` folder.
2. Open any .md file and click 🖉 (or `E` on your keyboard) to start editing.
3. Make the changes to the page you want and scroll to the bottom.
4. Add a short comment to explains your changes and click `Propose changes`.
5. Next page might look complicated, but all you need to do next is click `Create pull request`.
6. Here you can adjust the title and/or add extra comment and then click `Create pull request`.
7. That's it!

## Contributing from the forked repository

1. Click `Fork` button at the top right.
2. Click `Create fork`.
3. Go to the `docs` folder.
4. Open any .md file and click 🖉 (or `E` on your keyboard) to start editing.
5. Make the changes to the page you want and scroll to the bottom.
6. Add a short comment to explains your changes and select `Create a new branch for this commit and start a pull request.`. You can name the branch whatever you want or leave the default.
7. Click `Propose changes`.
7. Next page might look complicated, but all you need to do next is click `Create pull request`.
8. Here you can adjust the title and/or add extra comment and then click `Create pull request`.
9. That's it!
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Stash-Docs
Website: https://stashapp.github.io/Stash-Docs

# Contributing

Everyone is welcome to help with the documentation. All changes are managed through pull requests.

Read step-by-step guide on how to create a pull request [CONTRIBUTING.md](CONTRIBUTING.md).

# Running locally with Ruby

## Prerequsites
Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
remote_theme: just-the-docs/just-the-docs
plugins:
- jekyll-remote-theme
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
exclude: ["Gemfile", "Gemfile.lock", "LICENSE", "CONTRIBUTING.md", "README.md",]

title: Stash-Docs
description: Documentation for Stash software
Expand Down Expand Up @@ -31,7 +31,7 @@ nav_external_links:

# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_link_text: "Edit this page on GitHub"
gh_edit_repository: "https://github.com/stashapp/Stash-Docs" # the github URL for your repo
gh_edit_branch: "main" # the branch that your docs is served from
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately
Expand Down

0 comments on commit 8e6216d

Please sign in to comment.