Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 6ea7bd6

Browse filesBrowse files
nedbatnedbat
authored
contrib: restructure Getting Started - Setup and Building into a Workflows section (#1467)
* todo: why duplicate toctree docs here? * general re-organization * contrib: replace Get Started with Workflows * a central links file This makes it easier to move content around without worrying about where the links are defined. It will also be easier to have canonical links that can be used from multiple places in the guide. * contrib: restructure Getting Started - Setup and Building into a Workflows section The Getting Started section has a lot of technical detail. I thought it would be better moved to the end, and referenced from the contribution paths earlier in the guide. I haven't updated the paths yet. Also: - I added a central links.rst that can be included anywhere. - I omitted the "Editors and tools" section. It doesn't provide any useful information. - Perhaps the Workflows section could be further categorized. - The `c_blah_start` and `c_blah_end` comments are only for the temporary inclusions being used to demonstrate the new organization. * re-order the columns
1 parent f4df9cc commit 6ea7bd6
Copy full SHA for 6ea7bd6

File tree

Expand file treeCollapse file tree

17 files changed

+252
-41
lines changed
Filter options
Expand file treeCollapse file tree

17 files changed

+252
-41
lines changed

‎contrib/core-team/index.rst

Copy file name to clipboardExpand all lines: contrib/core-team/index.rst
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
|purpose|
66

77

8+
.. _c_coreteam:
9+
810
=========
911
Core team
1012
=========

‎contrib/get-started/index.rst

Copy file name to clipboardExpand all lines: contrib/get-started/index.rst
-15Lines changed: 0 additions & 15 deletions
This file was deleted.

‎contrib/index.rst

Copy file name to clipboardExpand all lines: contrib/index.rst
+16-13Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ these common sections:
5252

5353
* :ref:`c_intro`
5454
* :ref:`c_project`
55-
* :ref:`c_gettingstarted`
5655

5756
Then choose a path based on your type of activity:
5857

@@ -68,18 +67,10 @@ major section at the top of each column.]*
6867
:widths: 10 10 10
6968
:header-rows: 1
7069

71-
* - :ref:`Triaging <c_triage>`
72-
- :ref:`Documentation <c_docs>`
70+
* - :ref:`Documentation <c_docs>`
7371
- :ref:`Code <c_code>`
72+
- :ref:`Triaging <c_triage>`
7473
* -
75-
* :ref:`tracker`
76-
* :ref:`triaging`
77-
* :ref:`helptriage`
78-
* :ref:`experts`
79-
* :ref:`labels`
80-
* :ref:`gh-faq`
81-
* :ref:`triage-team`
82-
-
8374
* :ref:`docquality`
8475
* :ref:`documenting`
8576
* :ref:`style-guide`
@@ -95,21 +86,33 @@ major section at the top of each column.]*
9586
* :ref:`communication`
9687
* :ref:`gitbootcamp`
9788
* :ref:`devcycle`
89+
-
90+
* :ref:`tracker`
91+
* :ref:`triaging`
92+
* :ref:`helptriage`
93+
* :ref:`experts`
94+
* :ref:`labels`
95+
* :ref:`gh-faq`
96+
* :ref:`triage-team`
97+
98+
Core team members will find guidance in the :ref:`c_coreteam` section.
9899

100+
Contents
101+
========
99102

100103
.. toctree::
101104
:maxdepth: 3
102105

103106
contrib-plan
104107
intro/index
105108
project/index
106-
get-started/index
107109
triage/index
108-
code/index
109110
doc/index
111+
code/index
110112
core-team/index
111113
user-success
112114
security
115+
workflows/index
113116

114117

115118
.. _Python: https://www.python.org/

‎contrib/project/directory-structure.rst

Copy file name to clipboard
+17Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. important::
2+
3+
|draft|
4+
5+
|purpose|
6+
7+
.. _c_directory_structure:
8+
9+
===================
10+
Directory structure
11+
===================
12+
13+
[This is the :ref:`build_directory_structure` section from the devguide.]
14+
15+
.. include:: ../../getting-started/setup-building.rst
16+
:start-after: c_directory_structure_start
17+
:end-before: c_directory_structure_end

‎contrib/project/index.rst

Copy file name to clipboardExpand all lines: contrib/project/index.rst
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,6 @@ moving parts, who is involved, how do they interact?]
2424
governance
2525
generative-ai.rst
2626
github
27+
directory-structure.rst
2728
channels
2829
outreach

‎contrib/workflows/codespaces.rst

Copy file name to clipboard
+17Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. important::
2+
3+
|draft|
4+
5+
|purpose|
6+
7+
.. _c_using_codespaces:
8+
9+
=======================
10+
Using GitHub Codespaces
11+
=======================
12+
13+
[This is the :ref:`using-codespaces` section from the devguide.]
14+
15+
.. include:: ../../getting-started/setup-building.rst
16+
:start-after: c_codespaces_start
17+
:end-before: c_codespaces_end

‎contrib/workflows/compile.rst

Copy file name to clipboard
+22Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. important::
2+
3+
|draft|
4+
5+
|purpose|
6+
7+
.. _c_compiling:
8+
9+
=================
10+
Compile and build
11+
=================
12+
13+
.. note::
14+
[This is the :ref:`compiling` section from the devguide. I think this page
15+
is too long and could be split by build target, but we can leave that for a
16+
later time.]
17+
18+
.. include:: ../../getting-started/setup-building.rst
19+
:start-after: c_compile_and_build_start
20+
:end-before: c_compile_and_build_end
21+
22+
.. include:: ../../links.rst

‎contrib/workflows/get-source.rst

Copy file name to clipboard
+19Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. important::
2+
3+
|draft|
4+
5+
|purpose|
6+
7+
.. _c_checkout:
8+
9+
===================
10+
Get the source code
11+
===================
12+
13+
.. note::
14+
[This is the :ref:`checkout` section from the devguide. We might need to edit
15+
it to clarify that some steps are only needed for code contribution.]
16+
17+
.. include:: ../../getting-started/setup-building.rst
18+
:start-after: c_get_source_code_start
19+
:end-before: c_get_source_code_end

‎contrib/workflows/index.rst

Copy file name to clipboard
+25Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _c_workflows:
2+
3+
=========
4+
Workflows
5+
=========
6+
7+
.. important::
8+
9+
|draft|
10+
11+
|purpose|
12+
13+
14+
This section contains details of workflows needed for all kinds of
15+
contribution.
16+
17+
.. toctree::
18+
19+
install-git.rst
20+
get-source.rst
21+
install-dependencies.rst
22+
compile.rst
23+
regenerate.rst
24+
troubleshooting.rst
25+
codespaces.rst

‎contrib/workflows/install-dependencies.rst

Copy file name to clipboard
+17Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. important::
2+
3+
|draft|
4+
5+
|purpose|
6+
7+
.. _c_build-dependencies:
8+
9+
====================
10+
Install Dependencies
11+
====================
12+
13+
[This is the :ref:`build-dependencies` section from the devguide.]
14+
15+
.. include:: ../../getting-started/setup-building.rst
16+
:start-after: c_install_dependencies_start
17+
:end-before: c_install_dependencies_end

‎contrib/workflows/install-git.rst

Copy file name to clipboard
+17Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. important::
2+
3+
|draft|
4+
5+
|purpose|
6+
7+
.. _c_vcsetup:
8+
9+
===========
10+
Install Git
11+
===========
12+
13+
[This is the :ref:`vcsetup` section from the devguide.]
14+
15+
.. include:: ../../getting-started/setup-building.rst
16+
:start-after: c_install_git_start
17+
:end-before: c_install_git_end

‎contrib/workflows/regenerate.rst

Copy file name to clipboard
+28Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. important::
2+
3+
|draft|
4+
5+
|purpose|
6+
7+
.. _c_regenerating:
8+
9+
===============================
10+
Regenerating auto-created files
11+
===============================
12+
13+
.. note::
14+
[These are two similar sections from the is the :ref:`setup-building` section from the devguide.]
15+
16+
Regenerate ``configure``
17+
========================
18+
19+
.. include:: ../../getting-started/setup-building.rst
20+
:start-after: c_regenerate_configure_start
21+
:end-before: c_regenerate_configure_end
22+
23+
Regenerate the ABI dump
24+
=======================
25+
26+
.. include:: ../../getting-started/setup-building.rst
27+
:start-after: c_regenerate_abi_start
28+
:end-before: c_regenerate_abi_end

‎contrib/workflows/troubleshooting.rst

Copy file name to clipboard
+17Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. important::
2+
3+
|draft|
4+
5+
|purpose|
6+
7+
.. _c_build_troubleshooting:
8+
9+
===========
10+
Install Git
11+
===========
12+
13+
[This is the :ref:`build_troubleshooting` section from the devguide.]
14+
15+
.. include:: ../../getting-started/setup-building.rst
16+
:start-after: c_build_troubleshooting_start
17+
:end-before: c_build_troubleshooting_end

‎documentation/markup.rst

Copy file name to clipboardExpand all lines: documentation/markup.rst
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1215,6 +1215,9 @@ units as well as normal text:
12151215
Table-of-contents markup
12161216
------------------------
12171217

1218+
.. TODO: This is a copy of the Sphinx description of the toctree directive.
1219+
Why duplicate it here?
1220+
12181221
Since reST does not have facilities to interconnect several documents, or split
12191222
documents into multiple output files, Sphinx uses a custom directive to add
12201223
relations between the single files the documentation is made of, as well as

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.