Skip to content
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

Refresh docs #2119

Merged
merged 1 commit into from
May 15, 2024
Merged

Refresh docs #2119

merged 1 commit into from
May 15, 2024

Conversation

ppfeister
Copy link
Collaborator

@ppfeister ppfeister commented May 12, 2024

https://github.com/ppfeister/sherlock/tree/feature/docu

Just cleaned things up a bit. Thoughts?

Also changed the Docker section to use the Docker Hub image rather than only offering build from source. Changed pip to pipx. Once we're back on ${python repo}, the pipx section will be changed as well to use that image rather than a github url.

@sdushantha
Copy link
Member

Didn't know having README.md inside docs/ would still allow GitHub to find it and render it on the home page of the repo. So this is cool and I like the structure.

I do have some suggestions and would like to know what you think.


For the installation section, having something like this would be cleaner and allow the users to quickly find the installation instructions to their liking:

Installation

pipx install git+https://github.com/sherlock-project/sherlock.git
dnf
sudo dnf copr enable ppfeister/torrequest
sudo dnf copr enable ppfeister/exrex
sudo dnf copr enable ppfeister/sherlock
sudo dnf install python-sherlock
Docker
docker pull sherlockproject/sherlock

Docker-specific usage instructions can be found here.


@ppfeister
Copy link
Collaborator Author

( A )

I've never personally liked spoilers for this, but we can use them

I've always felt that they made navigation a bit more of a pain since you can't ctrl-F search for collapsed text --- you also can't quickly visually scan a page for their contents either

( B )

We shouldn't use dnf as the section title for now as that implies it'll also work on RHEL and CentOS, which it isn't yet packaged for. As additional repositories are added (deb, aur, etc), I'd expect us to write this differently to keep things tidy.

( C )

This is ultimately a non-issue though, as I'm actually going to remove the fedora section for now. I'll add it back in once I get it pushed to the official repo, rather than using my copr packages.

Copy link
Member

@sdushantha sdushantha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very clean, thank you!

@sdushantha sdushantha merged commit 3f01b81 into sherlock-project:master May 15, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants