From 4533b4a3a627b4c9bf9a3c2243b9fc40f724d912 Mon Sep 17 00:00:00 2001 From: DeForest Richards Date: Thu, 5 Sep 2019 21:24:47 +0000 Subject: [PATCH] Docs: Update Community section on homepage This commit includes the following changes: Adds a Getting Involved section under Community. Moves the Development Process section under Community. Moves Sphinx Quickstart Template and How to submit an LLVM bug report from User Guides section to Getting Involved. llvm-svn: 371127 --- llvm/docs/UserGuides.rst | 10 -------- llvm/docs/index.rst | 63 +++++++++++++++++++++++++++++++----------------- 2 files changed, 41 insertions(+), 32 deletions(-) diff --git a/llvm/docs/UserGuides.rst b/llvm/docs/UserGuides.rst index 67a66d1..1148c4f 100644 --- a/llvm/docs/UserGuides.rst +++ b/llvm/docs/UserGuides.rst @@ -25,8 +25,6 @@ intermediate LLVM representation. Lexicon HowToAddABuilder yaml2obj - HowToSubmitABug - SphinxQuickstartTemplate MarkdownQuickstartTemplate Phabricator TestingGuide @@ -88,14 +86,6 @@ intermediate LLVM representation. :doc:`Release notes for the current release ` This describes new features, known bugs, and other limitations. -:doc:`HowToSubmitABug` - Instructions for properly submitting information about any bugs you run into - in the LLVM system. - -:doc:`SphinxQuickstartTemplate` - A template + tutorial for writing new Sphinx documentation. It is meant - to be read in source form. - :doc:`LLVM Testing Infrastructure Guide ` A reference manual for using the LLVM testing infrastructure. diff --git a/llvm/docs/index.rst b/llvm/docs/index.rst index fdabf20..40cadd4 100644 --- a/llvm/docs/index.rst +++ b/llvm/docs/index.rst @@ -71,22 +71,26 @@ Getting Started, How-tos, Developer Guides, and Tutorials. :doc:`SubsystemDocumentation` For API clients and LLVM developers. -Development Process Documentation -================================= +Community +========= -Information about LLVM's development process. +LLVM has a thriving community of friendly and helpful developers. +The two primary communication mechanisms in the LLVM community are mailing +lists and IRC. + +Getting Involved +---------------- + +LLVM welcomes contributions of all kinds. To get started, please review the following topics: .. toctree:: :hidden: Contributing DeveloperPolicy - Projects - LLVMBuild - HowToReleaseLLVM - Packaging - ReleaseProcess + SphinxQuickstartTemplate Phabricator + HowToSubmitABug BugLifeCycle :doc:`Contributing` @@ -95,6 +99,35 @@ Information about LLVM's development process. :doc:`DeveloperPolicy` The LLVM project's policy towards developers and their contributions. +:doc:`SphinxQuickstartTemplate` + A template + tutorial for writing new Sphinx documentation. It is meant + to be read in source form. + +:doc:`Phabricator` + Describes how to use the Phabricator code review tool hosted on + http://reviews.llvm.org/ and its command line interface, Arcanist. + +:doc:`HowToSubmitABug` + Instructions for properly submitting information about any bugs you run into + in the LLVM system. + +:doc:`BugLifeCycle` + Describes how bugs are reported, triaged and closed. + +Development Process +------------------- + +Information about LLVM's development process. + +.. toctree:: + :hidden: + + Projects + LLVMBuild + HowToReleaseLLVM + Packaging + ReleaseProcess + :doc:`Projects` How-to guide and templates for new projects that *use* the LLVM infrastructure. The templates (directory organization, Makefiles, and test @@ -114,20 +147,6 @@ Information about LLVM's development process. :doc:`Packaging` Advice on packaging LLVM into a distribution. -:doc:`Phabricator` - Describes how to use the Phabricator code review tool hosted on - http://reviews.llvm.org/ and its command line interface, Arcanist. - -:doc:`BugLifeCycle` - Describes how bugs are reported, triaged and closed. - -Community -========= - -LLVM has a thriving community of friendly and helpful developers. -The two primary communication mechanisms in the LLVM community are mailing -lists and IRC. - Mailing Lists ------------- -- 2.7.4