From 2ed91026fcfef83ce5ef466a15e078229a106a6f Mon Sep 17 00:00:00 2001 From: Alexandre Alapetite Date: Wed, 15 May 2024 08:58:10 +0200 Subject: Correct casing for GitHub (#6460) --- docs/en/admins/02_Prerequisites.md | 2 +- docs/en/developers/01_Index.md | 2 +- docs/en/developers/02_GitHub.md | 62 ++++++++++++++++++++++++++ docs/en/developers/02_Github.md | 62 -------------------------- docs/en/developers/03_Backend/05_Extensions.md | 2 +- docs/en/users/07_Frequently_Asked_Questions.md | 2 +- 6 files changed, 66 insertions(+), 66 deletions(-) create mode 100644 docs/en/developers/02_GitHub.md delete mode 100644 docs/en/developers/02_Github.md (limited to 'docs/en') diff --git a/docs/en/admins/02_Prerequisites.md b/docs/en/admins/02_Prerequisites.md index 490ff31c3..6902a97e7 100644 --- a/docs/en/admins/02_Prerequisites.md +++ b/docs/en/admins/02_Prerequisites.md @@ -32,6 +32,6 @@ It could happen that we make two releases in a short span of time if we have a r As its name suggests, the development version is the working codebase, intended for developers. **This release may be unstable!** -If you want to keep track of the most recent enhancements or help the developers with bug reports, this is the branch for you. If you use this version, please keep in mind that you need to follow the branch activity on Github (via [the branch RSS feed](https://github.com/FreshRSS/FreshRSS/commits/edge.atom), for instance), and manually pull new commits. +If you want to keep track of the most recent enhancements or help the developers with bug reports, this is the branch for you. If you use this version, please keep in mind that you need to follow the branch activity on GitHub (via [the branch RSS feed](https://github.com/FreshRSS/FreshRSS/commits/edge.atom), for instance), and manually pull new commits. Some say that the main developers use this branch on a daily basis without problem. They may know what they are doing… diff --git a/docs/en/developers/01_Index.md b/docs/en/developers/01_Index.md index c3787377a..0e59b8c12 100644 --- a/docs/en/developers/01_Index.md +++ b/docs/en/developers/01_Index.md @@ -6,7 +6,7 @@ Start by creating your development environment. A guide to setting up FreshRSS ## After That -* [Github Branching and Pushing](02_Github.md) +* [GitHub Branching and Pushing](02_GitHub.md) * [Running tests](03_Running_tests.md) * [Creating a pull request](04_Pull_requests.md) * [Releasing a new version](05_Release_new_version.md) diff --git a/docs/en/developers/02_GitHub.md b/docs/en/developers/02_GitHub.md new file mode 100644 index 000000000..066d6ffb0 --- /dev/null +++ b/docs/en/developers/02_GitHub.md @@ -0,0 +1,62 @@ +# Branching + +## Basic + +If you are new to Git, here are some of the resources you might find useful: + +* [GitHub’s blog post](https://github.com/blog/120-new-to-git) +* +* +* + +## Getting the latest code from the FreshRSS repository + +First you need to add the official repo to your remote repo list: + +```sh +git remote add upstream git@github.com:FreshRSS/FreshRSS.git +``` + +You can verify the remote repo is successfully added by using: + +```sh +git remote -v show +``` + +Now you can pull the latest development code: + +```sh +git checkout edge +git pull upstream edge +``` + +## Starting a new development branch + +```sh +git checkout -b my-development-branch +``` + +## Sending a patch + +```sh +# Add the changed file, here actualize_script.php +git add app/actualize_script.php +# Commit the change and write a proper commit message +git commit +# Double check all looks well +git show +# Push it to your fork +git push +``` + +Now you can create a PR based on your branch. + +## How to write a commit message + +A commit message should succinctly describe the changes on the first line. For example: + +> Fix broken icon + +If necessary, this can be followed by a blank line and a longer explanation. + +For further tips, see [here](https://chris.beams.io/posts/git-commit/). diff --git a/docs/en/developers/02_Github.md b/docs/en/developers/02_Github.md deleted file mode 100644 index 066d6ffb0..000000000 --- a/docs/en/developers/02_Github.md +++ /dev/null @@ -1,62 +0,0 @@ -# Branching - -## Basic - -If you are new to Git, here are some of the resources you might find useful: - -* [GitHub’s blog post](https://github.com/blog/120-new-to-git) -* -* -* - -## Getting the latest code from the FreshRSS repository - -First you need to add the official repo to your remote repo list: - -```sh -git remote add upstream git@github.com:FreshRSS/FreshRSS.git -``` - -You can verify the remote repo is successfully added by using: - -```sh -git remote -v show -``` - -Now you can pull the latest development code: - -```sh -git checkout edge -git pull upstream edge -``` - -## Starting a new development branch - -```sh -git checkout -b my-development-branch -``` - -## Sending a patch - -```sh -# Add the changed file, here actualize_script.php -git add app/actualize_script.php -# Commit the change and write a proper commit message -git commit -# Double check all looks well -git show -# Push it to your fork -git push -``` - -Now you can create a PR based on your branch. - -## How to write a commit message - -A commit message should succinctly describe the changes on the first line. For example: - -> Fix broken icon - -If necessary, this can be followed by a blank line and a longer explanation. - -For further tips, see [here](https://chris.beams.io/posts/git-commit/). diff --git a/docs/en/developers/03_Backend/05_Extensions.md b/docs/en/developers/03_Backend/05_Extensions.md index 602625cf8..164a309ed 100644 --- a/docs/en/developers/03_Backend/05_Extensions.md +++ b/docs/en/developers/03_Backend/05_Extensions.md @@ -2,7 +2,7 @@ ## About FreshRSS -FreshRSS is an RSS / Atom feed aggregator written in PHP dating back to October 2012. The official site is located at [freshrss.org](https://freshrss.org) and the official repository is hosted on Github: [github.com/FreshRSS/FreshRSS](https://github.com/FreshRSS/FreshRSS). +FreshRSS is an RSS / Atom feed aggregator written in PHP dating back to October 2012. The official site is located at [freshrss.org](https://freshrss.org) and the official repository is hosted on GitHub: [github.com/FreshRSS/FreshRSS](https://github.com/FreshRSS/FreshRSS). ## The problem diff --git a/docs/en/users/07_Frequently_Asked_Questions.md b/docs/en/users/07_Frequently_Asked_Questions.md index 548762510..4e10a5eca 100644 --- a/docs/en/users/07_Frequently_Asked_Questions.md +++ b/docs/en/users/07_Frequently_Asked_Questions.md @@ -27,7 +27,7 @@ Here are the steps to follow: 1. __Verify if the feed syntax is valid__ with the [W3C on-line tool](https://validator.w3.org/feed/ "RSS and Atom feed validator"). If it’s not valid, there’s nothing we can do. 1. __Verify SimplePie validation__ with the [SimplePie on-line tool](https://simplepie.org/demo/ "SimplePie official demo"). If it’s not recognized, there’s nothing we can do. -1. __Verify FreshRSS integration__ with the [demo](https://demo.freshrss.org "FreshRSS official demo"). If it’s not working, you need to [create an issue on Github](https://github.com/FreshRSS/FreshRSS/issues/new "Create an issue for FreshRSS") so we can have a look at it. If it’s working, there’s probably something fishy with the hosting server. +1. __Verify FreshRSS integration__ with the [demo](https://demo.freshrss.org "FreshRSS official demo"). If it’s not working, you need to [create an issue on GitHub](https://github.com/FreshRSS/FreshRSS/issues/new "Create an issue for FreshRSS") so we can have a look at it. If it’s working, there’s probably something fishy with the hosting server. ## How can you change a forgotten password? -- cgit v1.2.3