Skip to content

Commit

Permalink
Update path for images
Browse files Browse the repository at this point in the history
  • Loading branch information
@DogmaDragon
DogmaDragon committed Dec 1, 2022
1 parent d0af709 commit 8c34745
Show file tree
Hide file tree
Showing 12 changed files with 31 additions and 38 deletions.
3 changes: 1 addition & 2 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# ignore directories for local testing
.jekyll-cache/
_site/
.vscode
cheatsheet.md
.vscode
2 changes: 1 addition & 1 deletion docs/Beginner-Guides/Exclude-File-Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ exclude:

and thats how it looks if you use UI (notice the difference for the `\` character)

![regexUI](assets/regexui.png)
![regexUI]({{ site.baseurl }}/docs/assets/regexui.png)

{: .note }
Useful [link](https://regex101.com/?flavor=golang){:target="_blank"} to experiment with regexps (we use "Golang" as the regex flavour).
18 changes: 9 additions & 9 deletions docs/Beginner-Guides/Guide-To-Scraping.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ The following is our recommended procedure for new Stash users who want to get i

1. Navigate to the Settings page (⚙ icon in top right), make sure you're on "Tasks" in the sidebar to the left, then find the first heading "Library" in the middle of the page. Make sure "Generate perceptual hashes" is turned on so PHashes will be created automatically each time you run a scan to add new scenes. This will slow down the scanning process, but for most users [it's worth it](https://guidelines.stashdb.org/docs/getting-started-stashdb/#whats-a-phash){:target="_blank"}. PHashes are the main way to match your scenes with our data on StashDB.

![How to generate PHashes on scan](assets/gen-phashes-on-scan.jpg)
![How to generate PHashes on scan]({{ site.baseurl }}/docs/assets/gen-phashes-on-scan.jpg)

{:style="counter-reset:none"}
1. PHash generation is not turned on by default, so you'll need to generate them manually if you haven't already. This can be done on your entire library on the same Settings --> Tasks page, scroll down to the "Generated Content" heading. Make sure "Perceptual hashes (for deduplication)" is turned on and click the "Generate" button at the top. As long as "Overwrite existing generated files" is turned off, this will only generate missing files and hashes.

![How to generate PHashes manually](assets/gen-phashes-manually.jpg)
![How to generate PHashes manually]({{ site.baseurl }}/docs/assets/gen-phashes-manually.jpg)

---

Expand All @@ -57,17 +57,17 @@ If you haven't set up StashDB in your Stash settings yet, now's the time to do i

1. Go to your Scenes page on Stash and click the double 🔖 icon to the far right of the search bar. This is your Scene Tagger view and should be your first choice for pulling data, not Identify / Autotag / Filename Parser / URL Scrapers / etc. Always use the Scene Tagger first, the rest are for users with more specific needs who understand the strengths and weaknesses of each tool.

![How to find the Scene Tagger](assets/find-scene-tagger.jpg)
![How to find the Scene Tagger]({{ site.baseurl }}/docs/assets/find-scene-tagger.jpg)

{:style="counter-reset:none"}
1. First, click the "Scrape All" button. This will use your PHashes to find matching scenes on StashDB for every scene on the current page. The "Scrape by fragment" buttons will do the same thing but just for one scene at a time. Also, you may want to change your Scene Tagger settings with the ⚙ icon next to "Scrape All." You can tell it to Merge (keep all) tags, Overwrite (keep only new) tags, or ignore StashDB's tags entirely (leave box unchecked). If you plan on [contributing to StashDB](https://guidelines.stashdb.org/docs/getting-started-stashdb/#contributing-to-stashdb){:target="_blank"}, you should have "Show male performers" turned on to better follow [these guidelines](https://guidelines.stashdb.org/docs/scenes/scene-performers/#missing-scene-performers){:target="_blank"}.

![Running "Scrape All" and "Search"](assets/scrape-all-and-search.jpg)
![Running "Scrape All" and "Search"]({{ site.baseurl }}/docs/assets/scrape-all-and-search.jpg)

{:style="counter-reset:none"}
1. If your fingerprint search doesn't return a correct result for your scene, you can try searching with the "Query" field using title, performer, release date, or studio. Try to use as little text as possible to find your scene. Otherwise, unnecessary words that do not match StashDB's info may block correct results. If you can find the matching scene on StashDB.org but can't find it using the Scene Tagger, you can use the scene's [StashID](https://guidelines.stashdb.org/docs/getting-started-stashdb/#whats-a-stashid){:target="_blank"} as your Tagger query.

![How to find a StashID](assets/find-stashid.jpg)
![How to find a StashID]({{ site.baseurl }}/docs/assets/find-stashid.jpg)

{:style="counter-reset:none"}
1. Be sure to double-check that each selected result matches your scene before clicking the "Save" button at the bottom of each card. **If you're confident that all of your saved matches are accurate**, you may click the "Submit fingerprints" button after you're done. This will add your files' hashes to StashDB to make them easier for other users to find. But again, **make sure your files were matched correctly first**. The button will appear right next to the "Scrape All" button.
Expand All @@ -81,7 +81,7 @@ If you haven't set up StashDB in your Stash settings yet, now's the time to do i
{:style="counter-reset:none"}
1. First step is to make an account at [metadataapi.net](https://metadataapi.net/register){:target="_blank"} which is ThePornDB's website. With your account created, navigate to your [API Tokens](https://metadataapi.net/user/api-tokens){:target="_blank"} page. Type "stash" as your token's name (or whatever you'd prefer), make sure the "read" permission is checked (you don't need the others), and click the "Create" button. A pop-up will display your newly created token. **Save your API token somewhere so you can find it later!** It will not be visible on ThePornDB's website after you close the pop-up. If you lose it, you may need to create a new one and repeat this entire setup process. This can be done in a password manager, notes app, or a well-placed text file.

![How to create an API token on ThePornDB](assets/create-tpdb-token.jpg)
![How to create an API token on ThePornDB]({{ site.baseurl }}/docs/assets/create-tpdb-token.jpg)


{:style="counter-reset:none"}
Expand All @@ -98,17 +98,17 @@ If you haven't set up StashDB in your Stash settings yet, now's the time to do i
{:style="counter-reset:none"}
1. Now we need to move our scraper file into the right folder for Stash to see it. The exact location is going to be a little different for everybody depending on where and how you've installed Stash. By default, it should go in a folder named `scrapers` in the same directory as your `config.yml` file. In the example directory below, you'll also see `ThePornDB_api-key.txt` where I've saved my API key for safekeeping in case I need it again later. If you're having trouble finding where this folder is, feel free to ask in the **#help** channel on [Discord](https://discord.com/channels/559159668438728723){:target="_blank"}.

![Location of "scrapers" folder](assets/scrapers-folder-location.jpg)
![Location of "scrapers" folder]({{ site.baseurl }}/docs/assets/scrapers-folder-location.jpg)

{:style="counter-reset:none"}
1. For our last step of setup, we need to go back into Stash. Navigate to the Settings page, click on "Metadata Providers" in the sidebar to the left, and scroll down to the "Scrapers" heading. Click the "🔃 Reload scrapers" button just below it. Now click "> Scene Scrapers" to expand that list of recognized scraper files. If you've done everything right, you should find your TPDB scraper here.

![ThePornDB in the list of scene scrapers](assets/tpdb-scene-scraper-entry.jpg)
![ThePornDB in the list of scene scrapers]({{ site.baseurl }}/docs/assets/tpdb-scene-scraper-entry.jpg)

{:style="counter-reset:none"}
1. Finally, we can use the Scene Tagger to scrape from ThePornDB. First you'll need to switch to "ThePornDB" as the Tagger's source. It will always default to a Stash-Box source, so you'll need to switch it every time you need something else. Use the same process here as [we used with StashDB and the Scene Tagger](#use-the-scene-tagger). The "Scrape All" and "Scrape by fragment" buttons will search using your filename and your OSHash. If these don't give you the right results, you can try the "Search" button and customize your search terms as needed. Remember to use as few terms as possible in your search because unneccessary words that don't match ThePornDB's info may block correct results. You could also [search TPDB itself](https://metadataapi.net/scenes){:target="_blank"} to find your scene first if you're having trouble with the Tagger's search or if you don't have the right search terms in your filename. Then, you can copy and paste the scene's URL slug (everything in the address bar after `https://metadataapi.net/scenes/`) into the Scene Tagger to quickly search with the exact same studio and title on TPDB. You can also copy-paste additional terms from TPDB's page if you need to narrow down the Tagger's results more.

![Tagger source set to ThePornDB](assets/tagger-source-tpdb.png)
![Tagger source set to ThePornDB]({{ site.baseurl }}/docs/assets/tagger-source-tpdb.png)

- **For those wanting to contribute to StashDB**: As noted before, ThePornDB leans heavily on automated scrapers to pull all of their info. Often that data is incomplete or inaccurate compared to what we'd want on StashDB. Before you [submit your scene to StashDB](https://guidelines.stashdb.org/docs/getting-started-stashdb/#submitting-drafts-to-stashdb){:target="_blank"}, you'll need to double-check your info, clean it up a bit first, and make sure you're following [these guidelines](https://guidelines.stashdb.org/docs/scenes/){:target="_blank"}. Submitting to StashDB is discussed further in the [last step](#submit-to-stashdb) of this guide.

Expand Down
2 changes: 1 addition & 1 deletion docs/Getting-Started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ has_toc: false

| Windows | macOS | Linux | Docker |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| <span class="no-border">![Windows](Getting-Started/assets/windows_logo.svg)</span> | <span class="no-border">![macOS](Getting-Started/assets/mac_logo.svg)</span> | <span class="no-border">![Linux](Getting-Started/assets/linux_logo.svg)</span> | <span class="no-border">![Docker](Getting-Started/assets/docker_logo.svg)</span> |
| <span class="no-border">![Windows]({{ site.baseurl }}/docs/Getting-Started/assets/windows_logo.svg)</span> | <span class="no-border">![macOS]({{ site.baseurl }}/docs/Getting-Started/assets/mac_logo.svg)</span> | <span class="no-border">![Linux]({{ site.baseurl }}/docs/Getting-Started/assets/linux_logo.svg)</span> | <span class="no-border">![Docker]({{ site.baseurl }}/docs/Getting-Started/assets/docker_logo.svg)</span> |
| [Latest Release](https://github.com/stashapp/stash/releases/latest/download/stash-win.exe){:target="_blank"} <br /> <sup><sub>[Development Preview](https://github.com/stashapp/stash/releases/download/latest_develop/stash-win.exe){:target="_blank"}</sub></sup> | [Latest Release (Apple Silicon)](https://github.com/stashapp/stash/releases/latest/download/stash-macos-applesilicon){:target="_blank"} <br /> <sup><sub>[Development Preview (Apple Silicon)](https://github.com/stashapp/stash/releases/download/latest_develop/stash-macos-applesilicon){:target="_blank"}</sub></sup> <br />[Latest Release (Intel)](https://github.com/stashapp/stash/releases/latest/download/stash-macos-intel){:target="_blank"} <br /> <sup><sub>[Development Preview (Intel)](https://github.com/stashapp/stash/releases/download/latest_develop/stash-macos-intel){:target="_blank"}</sub></sup> | [Latest Release (amd64)](https://github.com/stashapp/stash/releases/latest/download/stash-linux){:target="_blank"} <br /> <sup><sub>[Development Preview (amd64)](https://github.com/stashapp/stash/releases/download/latest_develop/stash-linux){:target="_blank"}</sub></sup> <br /> [More Architectures...](https://github.com/stashapp/stash/releases/latest){:target="_blank"} | [Instructions](https://github.com/stashapp/stash/blob/master/docker/production/README.md){:target="_blank"} <br /> <sup><sub> [Sample docker-compose.yml](https://github.com/stashapp/stash/blob/master/docker/production/docker-compose.yml){:target="_blank"}</sub></sup> |

---
Expand Down
4 changes: 2 additions & 2 deletions docs/Getting-Started/First-Steps.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ parent: Getting Started
1. Open your Stash.
2. Go to `Settings` > `Library` and click `Add Directory`.
3. To change the drive letter/volume, just type it in the field.
![Drive location](assets/drive_location.png)
![Drive location]({{ site.baseurl }}/docs/assets/drive_location.png)
4. Select the folder containing the content you want to add. It will select the folder and all sub-folders.
5. Click `Confirm`.

Expand All @@ -35,7 +35,7 @@ parent: Getting Started

1. Open your Stash.
2. Go to `Settings` > `Tasks`.
![Scan options](assets/scan_options.png)
![Scan options]({{ site.baseurl }}/docs/assets/scan_options.png)

| Option | Description |
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
6 changes: 3 additions & 3 deletions docs/User-Interface-UI/Custom-CSS-Snippets.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Reduce left and right padding on Scene and Performer grid pages allowing for mor

This will hide the large scene scrubber under the video player and max out the player's height.

![Image](Themes/assets/css-scrubber.png)
![Image]({{ site.baseurl }}/docs/Themes/assets/css-scrubber.png)

```css
/* [Scenes tab] Hide the scene scrubber and max out the player's height */
Expand Down Expand Up @@ -332,9 +332,9 @@ Use `order` values below 0 to move specific buttons to the left of the non-order
and values above 1 to move them to the right of the non-ordered buttons.

**Before:**
![Navigation before](Themes/assets/navigation-before.png)
![Navigation before]({{ site.baseurl }}/docs/Themes/assets/navigation-before.png)
**After:**
![Navigation after](Themes/assets/navigation-after.png)
![Navigation after]({{ site.baseurl }}/docs/Themes/assets/navigation-after.png)

```css
/* [Global changes] Change the order of navigation bar buttons */
Expand Down
2 changes: 1 addition & 1 deletion docs/User-Interface-UI/Themes/Modern-Dark.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ div[data-rb-event-key="/scenes/markers"] {

### Screenshots

![Modern Dark preview #1](assets/modern-dark-1.jpg)
![Modern Dark preview #1]({{ site.baseurl }}/docs/assets/modern-dark-1.jpg)

## Install

Expand Down
Loading

0 comments on commit 8c34745

Please sign in to comment.