From bf344cd30230edbb06fbdaa482a86d3592dc4aa0 Mon Sep 17 00:00:00 2001 From: ldv8434 <65482502+ldv8434@users.noreply.github.com> Date: Sun, 10 Jan 2021 14:50:54 -0500 Subject: Update and add to documentation (#3348) * remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * re-fix link * remove mention of defunct mailing list * grammar fix * replace stream with feed * add optional items, replace stream with feed * replace stream with feed * fix word choice Co-authored-by: Frans de Jonge * fix word choice better reflect age of project Co-authored-by: Frans de Jonge * grammar fixes Co-authored-by: Frans de Jonge * remove double headings Co-authored-by: Frans de Jonge * change single quote to double quote for consistency * add subreddit link * change php module list to Dockerfile link * fix link to developer index, change html links to md for consistency * update css selector terms Co-authored-by: Frans de Jonge Co-authored-by: Frans de Jonge --- docs/en/developers/02_Github.md | 67 ----------------------------------------- 1 file changed, 67 deletions(-) (limited to 'docs/en/developers/02_Github.md') diff --git a/docs/en/developers/02_Github.md b/docs/en/developers/02_Github.md index a898dc23e..953785d4f 100644 --- a/docs/en/developers/02_Github.md +++ b/docs/en/developers/02_Github.md @@ -1,70 +1,3 @@ -# Reporting a bug or a suggestion - -Despite the care given to FreshRSS, it's still possible that bugs occur. The project is young and development is dynamic, so it can be corrected quickly. You might also have a feature in mind that doesn't yet exist. Regardless whether your idea seems silly, far-fetched, useless or too specific, please don't hesitate to propose it to us! "Ideas in the air" often find an attentive ear. It's new external perspectives that make the project evolve the most. - -If you're convinced that you should be heard, here's how you can go about it. - -## On GitHub - -GitHub is the ideal platform to submit your requests. It allows us to discuss a problem or suggestion with others and it often generates new ideas. Let's not neglect this "social" aspect! - - 1. [Go to the bug ticket manager](https://github.com/FreshRSS/FreshRSS/issues) - 2. Start by checking if a similar request hasn't already been made. If so, please feel free to add your voice to the request. - 3. If your request is new, [open a new bug ticket](https://github.com/FreshRSS/FreshRSS/issues/new) - 4. Finally, write your request. If you're fluent in English, it's the preferred language because it allows for discussion with the largest number of people. - 5. Please follow the tips below to make it easier to let your ticket be heard. - -## Informal - -Not everyone likes or uses GitHub for a variety of legitimate reasons. That is why you can also contact us in a more informal way. - -* On [our Mattermost chat](https://framateam.org/signup_user_complete/?id=e2680d3e3128b9fac8fdb3003b0024ee) -* On [the mailing lists](https://freshrss.org/announce-of-the-mailing-lists.html) -* At events / meetings around Free Software -* Over a beer in a bar -* Etc. - -## Tips - -Here are some tips to help you present your bug report or suggestion: - - -* **Pay attention to spelling**. Even if it's not always easy, try your best! -* **Give an explicit title to your request**, even if it's a bit long. This not only helps us understand your request, but also to find your ticket later. -* **One request = one ticket.** You may have lots of ideas while being afraid to spam the bug manager: it doesn't matter. It's better to have a few too many tickets than too many requests in one. We'll close and consolidate requests when possible. -* If you report a bug, think about **providing us with the FreshRSS logs** (accessible in the FreshRSS `data/log/` folder) and the **PHP logs** (the location may vary by distribution, but consider searching in `/var/log/httpd` or `/var/log/apache`). -* If you can't find the log files, specify it in your ticket so we know you've already searched. -* Not all bugs require logs, but if you have any doubts, it is better to provide them to us. Logs are important and very useful for debugging! -* The logs may reveal confidential information, so **be careful not to disclose anything sensitive.** - -In addition, when facing a bug, you're encouraged to follow this message format (from the [Sam & Max website](http://sametmax.com/template-de-demande-daide-en-informatique/): - -### What's my goal? - -Give the general context of what you were trying to do. - -### What have I been trying to do? - -Explain step by step what you have done so that we can reproduce the bug. - -### What results have I achieved? - -The bug: what you see that shouldn't have happened. Here you can provide the logs. - -### What was the expected result? - -So that we understand what you consider to be the problem. - -### What are my circumstances? - -Remember to give the following information if you know it: - - 1. Which browser? Which version? - 2. Which server: Apache, Nginx? Which version? - 3. Which version of PHP? - 4. Which database: SQLite, MySQL, MariaDB, PostgreSQL? Which version? - 5. Which distribution runs on the server? And... which version? - # Branching ## Basic -- cgit v1.2.3