Skip to content

Commit ebce359

Browse files
committed
docs: restructure general guidelines
move all general guidance documents into one folder tutorial
1 parent 964cbd8 commit ebce359

23 files changed

+173
-107
lines changed

docs/guidance/index.rst renamed to docs/contribute/ci/index.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,10 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
Guidance
16-
========
15+
CI
16+
##
1717

1818
.. toctree::
19-
:maxdepth: 2
19+
:maxdepth: 1
2020

21-
docs-as-code
2221
publishing-gh-pages

docs/process/guidance/contribution_request/index.rst renamed to docs/contribute/contribution_request/contribution_request.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
###############################
16-
Contribution Request Guideline
17-
###############################
15+
16+
Contribution Request Guideline
17+
##############################
1818

1919
.. gd_guidl:: Contribution Request Guideline
2020
:id: gd_guidl__contr_request_guideline

docs/process/guidance/index.rst renamed to docs/contribute/contribution_request/index.rst

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,10 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
.. _process_guidance:
16-
17-
#########
18-
Guidance
19-
#########
15+
Contribution Request
16+
####################
2017

2118
.. toctree::
2219
:maxdepth: 1
23-
:glob:
2420

25-
git/index.rst
26-
branch/index.rst
27-
feature_flags/index.rst
28-
general/index.rst
29-
contribution_request/index.rst
21+
contribution_request

docs/process/guidance/contribution_request/templates/feature_request_template.rst renamed to docs/contribute/contribution_request/templates/feature_request_template.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ To activate this feature, use the following feature flag:
5555

5656
.. note::
5757
The feature flag must reflect the feature name in snake_case. Further, it is prepended with ``experimental_``, as
58-
long as the feature is not yet stable. See :doc:`/process/guidance/feature_flags/index` for more information.
58+
long as the feature is not yet stable. See :ref:`feature_flags` for more information.
5959

6060

6161
Abstract

docs/process/guidance/contribution_request/templates/index.rst renamed to docs/contribute/contribution_request/templates/index.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,10 @@
1414
1515
.. _contribution_templates:
1616

17-
#######################
18-
Contribution Templates
19-
#######################
17+
Contribution Templates
18+
######################
2019

2120
.. toctree::
2221
:maxdepth: 1
23-
:glob:
2422

2523
feature_request_template.rst

docs/contribute/development/index.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2024 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
Development
16+
###########
17+
18+
.. toctree::
19+
:maxdepth: 1
20+

0 commit comments

Comments
 (0)