Skip to content

Commit e93b033

Browse files
committed
fixing doc broken references
1 parent 96416a0 commit e93b033

7 files changed

Lines changed: 24 additions & 20 deletions

File tree

docs/config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Options
8686
Require at least X percent code coverage across the org following the test run.
8787
Default: 90
8888
```
89-
89+
(add-a-custom-task)=
9090
### Add a Custom Task
9191

9292
To define a new task for your project, add the task name under the
@@ -534,7 +534,7 @@ will fetch the most recent production release, or the default branch if
534534
there are no releases. By specifying `resolution_strategy`, the behavior
535535
can be changed to match desired dependency resolution behavior, such as
536536
using beta releases or retrieving feature test packages from a commit
537-
status. See [](dependency-resolution) for
537+
status. See [](controlling-github-dependency-resolution) for
538538
more details about resolution strategies.
539539

540540
```{note}

docs/cumulusci-flow.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,7 @@ child branches. This means that despite
295295
`feature/large-feature__section1` having two child branches, they would
296296
not receive automerges until the parent branch tests successfully.
297297

298+
(release-to-future-release-merges)=
298299
### Release to (Future) Release Merges
299300

300301
Because release branches are so long-lived, and so much work goes into

docs/data.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For example, the 'dev' dataset is for 'dev' orgs, and it is used
2626
instead of the default dataset if it exists.
2727

2828
You can create a dataset by extracting data from an existing org
29-
or by authoring a [Snowfakery recipe](Generate-Fake-Data).
29+
or by authoring a [Snowfakery recipe](#generate-fake-data).
3030
Extracting from an existing org is easy for use-cases where the
3131
data already exists or can be readily created in an org. Snowfakery
3232
is better for cases where either a) you would like to dynamically
@@ -37,7 +37,7 @@ A Snowfakery dataset can consist of a single file with a name like
3737
`datasets/<datasetname>/<datasetname>.recipe.yml` . For example,
3838
`datasets/default/default.recipe.yml` or
3939
`datasets/qa/qa.recipe.yml`. The rest of what you need to know
40-
about Snowfakery is in the section [Generate Fake Data](Generate-Fake-Data).
40+
about Snowfakery is in the section [Generate Fake Data](#generate-fake-data).
4141

4242
### Extracting and Loading Sample Datasets
4343

@@ -816,11 +816,13 @@ Extract the data for a dataset from an org and persist it to disk.
816816

817817
`mapping` and either `sql_path` or `database_url` must be supplied.
818818

819-
Example: :
820-
819+
Example:
820+
```console
821821
cci task run extract_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa
822+
```
822823

823-
### <a name="data-load-dataset"></a> `load_dataset`
824+
(data-load-dataset)=
825+
### `load_dataset`
824826

825827
Load the data for a dataset into an org. If the storage is a database,
826828
persist new Salesforce Ids to storage.
@@ -840,9 +842,11 @@ persist new Salesforce Ids to storage.
840842

841843
`mapping` and either `sql_path` or `database_url` must be supplied.
842844

843-
Example: :
845+
Example:
844846

847+
```console
845848
cci task run load_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa
849+
```
846850

847851
### `generate_dataset_mapping`
848852

@@ -908,9 +912,11 @@ after their target records become available.
908912
- `namespace_prefix`: The namespace prefix to treat as belonging to
909913
the project, if any
910914

911-
Example: :
915+
Example:
912916

917+
```console
913918
cci task run generate_dataset_mapping --org qa -o namespace_prefix my_ns
919+
```
914920

915921
### `load_custom_settings`
916922

@@ -994,6 +1000,8 @@ option:
9941000

9951001
You can learn more about Snowfakery syntax in the next section.
9961002

1003+
(Generate-Fake-Data)=
1004+
9971005
## Generate Fake Data
9981006

9991007
It is possible to use CumulusCI to generate arbitrary amounts of

docs/dev.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,7 @@ The [](retrieve-changes) task supports both
6161
Salesforce DX and Metadata API-format source code. It utilizes the
6262
[SourceMember](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_sourcemember.htm)
6363
`sObject` to detect what has changed in an org, and also gives you
64-
discretion regarding which components are retrieved when compared to the
65-
[](dx-pull) task.
64+
discretion regarding which components are retrieved.
6665

6766
To retrieve _all_ changes in an org:
6867

@@ -161,14 +160,7 @@ code and metadata stored in the repository. After making changes in an
161160
editor, push these changes from your project's local repository to the
162161
target org.
163162

164-
If your project uses the Salesforce DX source format, use the
165-
[](dx-push) task.
166-
167-
```console
168-
$ cci task run dx_push
169-
```
170-
171-
If your project uses the Metadata API source format, use the
163+
To push your changes, use the
172164
[](deploy) task:
173165

174166
```console

docs/env-var-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ OS keychain is not available.
2626
Used for specifying a GitHub Repository for CumulusCI to use when
2727
running in a CI environment.
2828

29+
(cumulusci-system-certs)=
2930
## `CUMULUSCI_SYSTEM_CERTS`
3031

3132
If set to `True`, CumulusCI will configure the Python `requests` library
@@ -42,6 +43,7 @@ Your GitHub App's identifier.
4243
Contents of a JSON Web Token (JWT) used to [authenticate a GitHub
4344
app](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/##authenticating-as-a-github-app).
4445

46+
(github-token)=
4547
## `GITHUB_TOKEN`
4648

4749
A GitHub [personal access

docs/get-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ pipx install cumulusci
122122

123123
When finished, [verify your installation](verify-your-installation).
124124

125+
(update-environment-variables-manually)=
125126
#### Update Environment Variables Manually
126127

127128
1. Click Start and search for `edit environment variables`, or open

docs/headless.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ then the attributes: `callback_url`, `client_id`, and `client_secret`
8686
would need to be provided in the following format:
8787

8888
```json
89-
"{"callback_url": "<callback_url>", "client_id": "<client_id>", "client_secret": "<client_secret>"}"
89+
{"callback_url": "<callback_url>", "client_id": "<client_id>", "client_secret": "<client_secret>"}
9090
```
9191

9292
> The values `<callback_url>`, `<client_id>`, and `<client_secret>`

0 commit comments

Comments
 (0)