diff --git a/Documentation/GitHub/Index.rst b/Documentation/GitHub/Index.rst deleted file mode 100644 index 51109ea7..00000000 --- a/Documentation/GitHub/Index.rst +++ /dev/null @@ -1,209 +0,0 @@ -.. include:: /Includes.rst.txt -.. highlight:: rst -.. index:: GitHub -.. _work-with-github: -.. _useful-links: - -======================= -How to work with GitHub -======================= - - -.. tip:: **Looking for help on 'How to edit'?** - - Please head over to page :ref:`docs-contribute-github-method`. - - -.. index:: GitHub; Repository -.. _github-find-a-repository: - -How to find a GitHub repository -=============================== - -The source for every manual on docs.typo3.org (for example this manual :ref:`start` or -:ref:`t3coreapi:start`) is contained in a GitHub repository. - -In the repository, you can find the source files, but also the issues and pull requests. - -The repositories of the official manuals are all included in the organization -`TYPO3-Documentation `__. - -There, you can browse through the repositories or search for a specific -repository: - -.. image:: /Images/github-repo-search.png - :class: with-shadow - -Alternatively, on any rendered page on docs.typo3.org (for example, this page), -you can find the link :guilabel:`Repository` in the footer on the bottom -of the page. - - -.. index:: GitHub; Notifications -.. _github-get-notifications: - -Get notifications from GitHub -============================= - -You can get notifications for activity in a repository (for example new pull requests or -issues) by **watching** the repository: - - -#. Find the repository you would like to watch, see :ref:`github-find-a-repository` - For example, go to the repository for `TYPO3 Explained `__ -#. Click on the **Watch** button on the top of the page - -.. image:: /Images/watch-repo.gif - :class: with-shadow - - -.. index:: GitHub; Issues -.. _links-github-issues: - -Find issues -=========== - -Pick an issue for a topic you are familiar with and try to fix it. Some of the -issues address a problem, some are enhancements where new text needs to be -written. - -You can look at the open issues of a manual you are familiar with, pick one -and fix the problem. - -For example: - -* `Issues for this guide "Writing Documentation" - `__ -* `Issues for "Getting Started Tutorial" - `__ - - -Find issues for a specific manual ---------------------------------- - -From docs.typo3.org: - To find the issues for a specific manual click on the link - :guilabel:`Issues` in the footer on the bottom of the page. - -From the repository on GitHub: - If you have already located the repository on GitHub, you can find the Issues - by clicking on the :guilabel:`Issues` tab: - - .. image:: /Images/github-issues.png - :class: with-shadow - -From the list of repositories in `TYPO3-Documentation `__: - Look for the exclamation mark (!) issues icon: - - .. image:: /Images/github-list-issues.png - :class: with-shadow - - -.. _github-good-first-issue: -.. _useful-links-for-contributors: - -Links to GitHub issues ----------------------- - -Here are some links to GitHub issues in `TYPO3-Documentation `__. - -.. important:: - - GitHub will show a 404 page if you are not logged in following these links! - So, remember to log in first! - -For new contributors: - -* `Good first issues `__ (Link to GitHub) - -For contributors: - -* `All open, unassigned issues (without team, theme etc.) `__ (Link to GitHub) - -For team members and advanced contributors: - -* `All open issues - `__ (Link to GitHub) -* `All open, unassigned issues - `__ (Link to GitHub) - -The Docker image for rendering is in the organization **t3docs** (instead of TYPO3-Documentation): - -* `All open issues in t3docs `__ (Link to GitHub) - - -.. index:: GitHub; Issue solving -.. _github-solve-issue: - -Solve an Issue -============== - -When you solve an existing issue from GitHub, it is good practice to refer to it in the commit message. - -For example, write: - -.. code-block:: none - - Resolves: #12 - - -This will automatically close the issue and a link to the issue is displayed in the commit message and -pull request on GitHub. - -.. seealso:: - - :ref:`general-conventions-commit-messages` - - - -.. index:: - pair: GitHub; Pull requests - Pull requests - PR - see: PR; Pull requests -.. _github-pull-requests: - -Find Pull Requests -================== - -.. important:: - - GitHub will show a 404 page if you are not logged in following these links! - So, remember to log in first! - - -Anyone is welcome to review open pull requests! - -In **TYPO3-Documentation**: - -* `Open pull requests `__ (Link to GitHub) - -In **t3docs** (Docker image): - -* `Open pull requests `__ (Link to GitHub) - -About reviewing pull requests, you can look in the GitHub help pages: - -.. seealso:: - - * `About pull request reviews `__ (GitHub) - * `Commenting on a pull request `__ (GitHub) - -.. tip:: - - If you are reviewing a pull request and want to leave comments, make sure to - `mark the line `__ - in the PR. - - -Find pull requests that require my attention -============================================ - -When another contributor creates their own pull request, they might ask you to review -their change by assigning you to the pull request as an assignee. - -To review all requests that are assigned to you, select :guilabel:`Pull requests` from the main navigation bar -followed by :guilabel:`Review requests`. - -.. image:: /Images/github-review-requests.png - :class: with-shadow diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 48584c39..e42ca84a 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -119,7 +119,6 @@ What's new in this guide? WritingDocsOfficial/Index ToolsEditRest/Index RenderingDocs/Index - GitHub/Index .. toctree:: :hidden: diff --git a/Documentation/WritingDocsOfficial/HowYouCanHelp.rst b/Documentation/WritingDocsOfficial/HowYouCanHelp.rst index 36fce114..ed99e798 100644 --- a/Documentation/WritingDocsOfficial/HowYouCanHelp.rst +++ b/Documentation/WritingDocsOfficial/HowYouCanHelp.rst @@ -29,12 +29,57 @@ for a walkthrough. .. _how-you-can-help-fix-issues: +.. _links-github-issues: Fix issues ========== -See :ref:`links-github-issues`. As a new contributor, specifically look at issues -with the label :ref:`good first issue `. +Pick an issue for a topic you are familiar with and try to fix it. Some of the +issues address a problem, some are enhancements where new text needs to be +written. + +You can look at the open issues of a manual you are familiar with, pick one +and fix the problem. + +For example: + +* `Issues for this guide "Writing Documentation" + `__ +* `Issues for "Getting Started Tutorial" + `__ + + +.. _github-good-first-issue: +.. _useful-links-for-contributors: + +Links to GitHub issues +---------------------- + +Here are some links to GitHub issues in `TYPO3-Documentation `__. + +.. important:: + + GitHub will show a 404 page if you are not logged in following these links! + So, remember to log in first! + +For new contributors: + +* `Good first issues `__ (Link to GitHub) + +For contributors: + +* `All open, unassigned issues (without team, theme etc.) `__ (Link to GitHub) + +For team members and advanced contributors: + +* `All open issues + `__ (Link to GitHub) +* `All open, unassigned issues + `__ (Link to GitHub) + +The Docker image for rendering is in the organization **t3docs** (instead of TYPO3-Documentation): + +* `All open issues in t3docs `__ (Link to GitHub) .. _how-you-can-help-review-pr: @@ -42,12 +87,26 @@ with the label :ref:`good first issue `. Review pull requests ==================== -:ref:`Find an open pull request ` and review it. - Some pull requests make changes in documentation describing an aspect of TYPO3 you may know well. Help in this area is very much appreciated! +.. important:: + + GitHub will show a 404 page if you are not logged in following these links! + So, remember to log in first! + + +Anyone is welcome to review open pull requests! + +In **TYPO3-Documentation**: + +* `Open pull requests `__ (Link to GitHub) + +In **t3docs** (Docker image): + +* `Open pull requests `__ (Link to GitHub) + .. _how-you-can-help-write-new-content: