diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index cfc356f49..3259eca36 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,123 +1,153 @@ -# Contribute Guide +# How to Edit FMHY -> [!INFO] NOTE -> Some of these steps are easier if you're in our [Discord](https://rentry.co/fmhy-invite). It opens every Friday. +There are multiple ways you can contribute to this repository: +- [Link submissions](#submitting-a-link) +- [Reporting a site](#reporting-a-site) +- [Changes to the website itself](#making-changes) +- [Finding new sites](https://www.reddit.com/r/FREEMEDIAHECKYEAH/wiki/find-new-sites/) -Here you'll find some general guidelines for those who would like to start contributing. There are multiple ways to do this: +## Submitting a Link -- [Link Submissions](#additions) -- [Reporting an Existing Site](#reporting-a-site) -- [How to Edit and Preview Changes](#making-changes) -- [Finding New Sites](https://www.reddit.com/r/FREEMEDIAHECKYEAH/wiki/find-new-sites/) +> [!NOTE] +> If you haven't tested the link you'd like to submit, especially if it's a DDL site, please open an **[Issue](https://github.com/fmhy/edit/issues)** or reach out to us on **[Discord](https://rentry.co/fmhy-invite)** rather than making a Pull Request. -## Submissions +1. Before submitting a link, please **[search](https://redd.it/105xraz)** to make sure it's not already in the wiki. -> [!INFO] NOTE -> For bigger changes to the wiki, such as debloating efforts or the restructuring of a page/section, you must first discuss these with us via [Discord](https://rentry.co/fmhy-invite) before opening a [Pull Request](https://github.com/fmhy/edit/pulls). +2. The order of priority is: **Site > Git Repository > Store Link** +Please only use the store link if there's neither a site nor a Git repository available for the app/extension you'd like to submit. -**Don't submit any of the following:** +3. Always check to see if the site you'd like to submit has a Discord / Telegram server you can link with it. -- **💰️ Paid / Trial Sites** - We don't accept any paid or free trial only entries, with the exception of select paid [VPNs](/adblockvpnguide#vpn) and [Debrid](/downloadpiracyguide#leeches-debrid). -- **🕹️ Emulators** - Already listed on the [Game Tech Wiki](https://emulation.gametechwiki.com/index.php/Main_Page). -- **🌐 Web Browsers** - Already listed on [Comparison and Index Sites](/internet-tools#browser-tools). However, we accept privacy-based ones as well as normal Android browsers. -- **🔻 Leeches** - Unless already listed on existing [Leech Lists](../downloadpiracyguide#leeches-debrid), don't submit these. -- **🐧 Linux Distros** - They're already on [DistroWatch](https://distrowatch.com/). -- **🌍 Non-english Software** - We don't add non-english software sites (APKs, games, torrents, etc.) unless they have a very good reputation. -- **🗂️ Coding Libraries** - There's too many of them and there are better places to find them. -- **🎲 Mining / Betting Sites** - Don't submit anything related to betting, mining, BINs, CCs, etc. -- **🎮 Multiplayer Hacks** - Don't submit any hacks or exploits that give an unfair advantage in multiplayer games. -- **🖥️ Custom OS's** - We don't recommend people use these. +4. Find a suitable category for the link and then submit it by making a **[Pull Request](https://github.com/fmhy/edit/pulls)**. -### Adding a Site +#### Don't Submit: -For submitting new links, follow these steps: +**🕹️ Emulators**: +They're already on the **[Game Tech Wiki](https://emulation.gametechwiki.com/index.php/Main_Page)**. -- Make sure it's not already in the wiki. The easiest way to do this is to check our [Single Page](https://api.fmhy.net/single-page) using `ctrl+f`. -- Reach out via the feedback system, by opening an [Issue](https://github.com/fmhy/edit/issues), or join our [Discord](https://rentry.co/fmhy-invite). -- You can optionally include socials, tools, or any other additional info alongside the entry. -- Avoid opening pull requests. See [Link Testing](#link-testing) for more info. +**🌐 Normal Web Browsers** +They're already on the **[Browser Index](https://github.com/nerdyslacker/desktop-web-browsers)**, though we accept privacy-based ones. -### Reporting a Site +**🔻 Leeches**: +They're already on the **[File Hosting Wiki](https://filehostlist.miraheze.org/wiki/Free_Premium_Leeches)**. -> [!INFO] NOTE -> If it's urgent, you're allowed to request an invite via our feedback system. +**🐧 Distros**: +They're already on **[DistroWatch](https://distrowatch.com/)**. -For changes to existing entries, follow these steps: +**🎲 Mining / Betting Sites**: +Don't post anything related to betting, mining, BINs, CCs, etc. -- Reach out via any of the available methods, including opening a [Pull Request](https://github.com/fmhy/edit/pulls). -- Feel free to leave contact info when using the feedback system, if needed. Only trusted staff can view this. -- If you'd like to report a site removal or star change, you must include details as to why your changes should be accepted. +**🎮 Multiplayer Game Hacks**: +Don't post any hacks/exploits that give unfair advantages in multiplayer games. -### Link Testing +**🖥️ Custom Operating Systems** +We don't recommend people use these. -All additions have to first go through our testing process on [Discord](https://rentry.co/fmhy-invite). +## Reporting a Site -You can help us test new sites to figure out their use-case, safety, and whether they'd be a good fit for the wiki. +> [!TIP] +> If you want to make bigger changes to the wiki, such as debloating or restructuring a page/section, please discuss those changes with us via **[Discord](https://rentry.co/fmhy-invite)** before making a **[Pull Request](https://github.com/fmhy/edit/pulls)**. -Keep in mind certain sites (such as piracy sites) require more testing/vetting before they can be added. +You can do one of the following: -### Formatting Rules +- Reach out via the feedback system on any page of our [Website](https://fmhy.net/), or on **[Discord](https://rentry.co/fmhy-invite)** if you'd like to discuss your report. -The wiki will always have some variation either due to exceptions being made, the layout/structure, or the flexible nature of markdown itself. +- Open an **[Issue](https://github.com/fmhy/edit/issues)** or a **[Pull Request](https://github.com/fmhy/edit/pulls)** and don't forget to explain why you think the site(s) in question should be removed, unstarred, and/or changed. -For these reasons, there are too many conditions and nuances to satisfy to make an easy-to-follow guide. However, you can generally get an idea by looking at how existing links are structured. +## Making changes -If you're unsure, ask in the wiki channels on [Discord](https://rentry.co/fmhy-invite) and wait for a staff member to reply. +> [!TIP] +> The easiest way is to join our [Discord](https://rentry.co/fmhy-invite) to submit sites or any changes. -## Making Changes +If you want to make changes with instant site feedback, or are simply going to work with the site, you can do so with these 3 ways: -Instructions on various ways to edit the wiki and preview changes. +- [Using gitpod.io or GitHub Codespaces (recommended)](#using-gitpod-or-github-codespaces) +- [Using the GitHub editor](#using-the-github-editor) +- [Manually setting up a development environment](#manually-setting-up-a-development-environment) -### GitHub Editor -You can use the build-in web editor in two ways: +### Using Gitpod or GitHub Codespaces -1. Find the file you want to edit, look for the edit icon (of a pencil) and click on it, then make your changes. +You can use either [gitpod.io](https://gitpod.io/) or [GitHub Codespaces](https://github.com/features/codespaces) to edit the wiki. - ![Edit Button](https://files.catbox.moe/7w3hnm.png) +Follow these steps: -2. When you're done, click "Commit Changes..." then "Propose changes". Optionally add a commit description. +1. Fork the repository by clicking the "Fork" button in the top right corner. -3. You should now see a comparison page showing all your edits. Click "Create pull request", fill in the box describing your changes, then hit submit. +2. Now, to make changes, you can either use gitpod.io or GitHub Codespaces. -**OR** +#### Gitpod.io -1. Fork the repository by clicking the "Fork" button in the top right. +Login to your Gitpod account and click on the "New Workspace" button. Then select your fork and you should be in your gitpod workspace. -2. Navigate to your fork's homepage and press the `.` (period) key on your keyboard. This will open the repository in a VSCode-like environment on `github.dev`. - -3. Make your changes, then commit via the source control tab. - - ![Source Control](https://files.catbox.moe/pa571v.png) - -4. Back on your fork's homepage, click "Contribute" then "Open pull request". - -5. You should now see a comparison page showing all your edits. Click "Create pull request", fill in the box describing your changes, then hit submit. - -### Dev Environment - -If you're going to work on the site itself, or simply want to preview the site and any changes, you can do so by setting up a development environment. +To close the workspace, click on the "Gitpod" button at the bottom left corner then type "Stop Workspace" and hit enter. #### GitHub Codespaces -This creates an environment in the browser [(with 60h/month free quota)](https://docs.github.com/en/billing/managing-billing-for-your-products/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts). To use Codespaces, follow these steps: +Click on the "Code" button on the top right corner of the page and select "Codespaces" from the dropdown menu. -1. Fork the repository by clicking the "Fork" button in the top right. +To close the workspace, click on the "Code" button at the top right corner then click on "Stop Codespace" and hit enter. -2. Navigate to your fork's homepage and click on the green "Code" button above your repository, open "Codespaces" tab and click "Create codespace". +### Using the GitHub editor -3. You may have to wait ~5-10 minutes for the codespace to load. +1. Fork the repository by clicking the "Fork" button in the top right corner. You can open your repository in a VSCode-like environment by pressing `.` (dot) in your fork's homepage which will take you to `github.dev`. - ![Codespace Status](https://files.catbox.moe/5bp38f.png) +2. Find the file you want to edit. Find the "Edit" icon (of a pencil) and click on it. +Select edit button and make your changes. +![Select edit button](https://i.imgur.com/lnQfeo3.png) -4. Once it has loaded, run `pnpm i && pnpm docs:dev` to start the preview. Then when it appears, click "Open in Browser" in the bottom right. +3. Scroll down and select "Propose changes", and "Create Pull Request" on the next page, and don't forget to explain why you think the site(s) in question should be removed, unstarred, and/or changed. -5. Make your changes and commit. +![propose changes](https://i.imgur.com/IaSJvnO.png) +![create pull request](https://i.imgur.com/z5Za72l.png) -6. To shut it down, click the "Code" button again and look for the `...` dropdown next to your codespace, then click "Stop codespace". +### Manually setting up a development environment -#### Local Instance +#### Manual -Making changes on a local repository may require a basic understanding of Git. You can find learning resources [here](/edupiracyguide#developer-learning). +1. Fork the repository by clicking the "Fork" button in the top right corner. -More info on manual setup can be found [here](/other/selfhosting). \ No newline at end of file +2. Make sure you have [Node.js](https://nodejs.org/en/), [pnpm](https://pnpm.io/), [git](https://git-scm.com/), and [VSCode](https://code.visualstudio.com/) or any other editor installed. Alternatively, `pnpm` has `pnpm env` you can use to manage Node. + +3. Clone your forked repository to your local machine. + +4. Open the cloned repository in your editor of choice. Find the file you want to work on, make changes. + +5. Add your changes with git (`git add `) and commit (`git commit -m "commit message"`), then push them (`git push`). + +6. Create a pull request by clicking the "New Pull Request" button in your forked repository, and don't forget to explain why you think the site(s) in question should be removed, unstarred, and/or changed. + +#### Nix + +You can use [nix](https://nixos.org/) to set up a development environment, we have a [flake](https://nixos.wiki/wiki/Flakes) that setups `nodejs` and `pnpm`. + +1. Fork the repository by clicking the "Fork" button in the top right corner and clone your forked repository to your local machine. + +2. Run `nix flake update` to update the flake lock file. + +3. Run `nix develop` to enter the development environment. + +4. Make changes. + +5. Exit the development environment by running `exit`. + +6. Commit your changes and push them to your forked repository. + +7. Create a pull request by clicking the "New Pull Request" button in your forked repository, and don't forget to explain why you think the site(s) in question should be removed, unstarred, and/or changed. + + +#### Keeping Your Fork Updated + +To keep your fork up to date with the main repository: + +```bash +# Add the upstream remote (only needed once) +git remote add upstream https://github.com/fmhy/edit.git + +# Fetch upstream changes +git fetch upstream + +# Merge upstream changes into your local main branch +git checkout main +git merge upstream/main +``` \ No newline at end of file diff --git a/.mise.toml b/.mise.toml index e71cb5c92..5d3cdd5a1 100644 --- a/.mise.toml +++ b/.mise.toml @@ -1,7 +1,6 @@ # https://github.com/vitejs/vite/issues/17291 [tools] -node = "latest" -pnpm = "latest" +node = "21" [tasks] d = "nrr docs:dev --host" diff --git a/docker-compose.yaml b/docker-compose.yaml index ebe39cf5b..021de6b1b 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -10,5 +10,6 @@ services: ports: - '4173:4173' + networks: fmhy: diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index dd395e66a..1d6407f75 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -152,9 +152,7 @@ export default defineConfig({ search, footer: { message: `${feedback} (rev: ${commitRef})`, - copyright: - `© ${new Date().getFullYear()}, Estd 2018.` + - `
This site does not host any files.` + copyright: `© ${new Date().getFullYear()}, Estd 2018.
This site does not host any files.` }, editLink: { pattern: 'https://github.com/fmhy/edit/edit/main/docs/:path', diff --git a/docs/.vitepress/constants.ts b/docs/.vitepress/constants.ts index b9baf63b1..faece2094 100644 --- a/docs/.vitepress/constants.ts +++ b/docs/.vitepress/constants.ts @@ -152,12 +152,8 @@ export const nav: DefaultTheme.NavItem[] = [ { text: '🌐 Search', link: '/posts/search' }, { text: '🔖 Bookmarks', link: 'https://github.com/fmhy/bookmarks' }, { text: '✅ SafeGuard', link: 'https://github.com/fmhy/FMHY-SafeGuard' }, - { text: '🚀 Startpage', link: 'https://fmhy.net/startpage' }, { text: '📋 snowbin', link: 'https://pastes.fmhy.net' }, - { - text: '®️ Redlib', - link: 'https://redlib.fmhy.net/r/FREEMEDIAHECKYEAH/wiki/index' - }, + { text: '®️ Redlib', link: 'https://redlib.fmhy.net/r/FREEMEDIAHECKYEAH/wiki/index' }, { text: '🔎 SearXNG', link: 'https://searx.fmhy.net/' }, { text: '💡 Site Hunting', diff --git a/docs/.vitepress/hooks/Template.vue b/docs/.vitepress/hooks/Template.vue index da9211919..e309fd885 100644 --- a/docs/.vitepress/hooks/Template.vue +++ b/docs/.vitepress/hooks/Template.vue @@ -1,13 +1,28 @@