Skip to content

Commit ef5e649

Browse files
committed
fixing broken references in documentation and removing unicode emojis from doc gen
1 parent e93b033 commit ef5e649

15 files changed

Lines changed: 201 additions & 184 deletions

File tree

.github/release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ changelog:
77
authors:
88
- app/github-actions
99
categories:
10-
- title: Critical Changes 🛠
10+
- title: Critical Changes
1111
labels:
1212
- critical-change
13-
- title: Changes 🎉
13+
- title: Changes
1414
labels:
1515
- enhancement
1616
- "*"
1717
exclude:
1818
labels:
1919
- bug
20-
- title: Issues Fixed 🩴
20+
- title: Issues Fixed
2121
labels:
2222
- bug

cumulusci/tasks/release_notes/task.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ class ParentPullRequestNotes(BaseGithubTask):
141141
142142
If you have a pull request on branch feature/myFeature that you would like to rebuild notes
143143
for use the branch_name and force options:
144-
cci task run github_parent_pr_notes --branch-name feature/myFeature --force True
144+
- cci task run github_parent_pr_notes --branch-name feature/myFeature --force True
145145
"""
146146
UNAGGREGATED_PR_HEADER = "\r\n\r\n# Unaggregated Pull Requests"
147147

docs/conf.py

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,8 @@
222222
# This is the file name suffix for HTML files (e.g. ".xhtml").
223223
# html_file_suffix = None
224224

225+
suppress_warnings = ["ref.duplicate_label"]
226+
225227
# Output file base name for HTML help builder.
226228
htmlhelp_basename = "cumuluscidoc"
227229

@@ -231,14 +233,11 @@
231233

232234

233235
latex_elements = {
234-
# The paper size ('letterpaper' or 'a4paper').
235-
# 'papersize': 'letterpaper',
236-
# The font size ('10pt', '11pt' or '12pt').
237-
# 'pointsize': '10pt',
238-
# Additional stuff for the LaTeX preamble.
239-
# 'preamble': '',
236+
'preamble': r'''\renewcommand{\familydefault}{\sfdefault} % Set default font to sans-serif
237+
''',
240238
}
241239

240+
242241
# Grouping the document tree into LaTeX files. List of tuples
243242
# (source start file, target name, title, author, documentclass
244243
# [howto/manual]).
@@ -247,13 +246,12 @@
247246
"index",
248247
"cumulusci.tex",
249248
"CumulusCI Documentation",
250-
"""Kamalnath Devarakonda\\\\
251-
Sr Director Software Engineering\\\\
252-
kdevarakonda@salesforce.com""",
249+
r'Cumulus Suite Development Team\\\texttt{sfdo-mrbelvedere@salesforce.com}',
253250
"manual",
254251
)
255252
]
256253

254+
exclude_patterns = ['history.md'] # Ensures history.md is excluded
257255
# The name of an image file (relative to this directory) to place at
258256
# the top of the title page.
259257
# latex_logo = None

docs/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -723,7 +723,7 @@ in your cumulusci.yml file.
723723

724724
### Customizing Metadata Deployment
725725

726-
CumulusCI's `deploy` task offers deep flexibility to customize your deployment process. Review [](deploy) for an in-depth guide.
726+
CumulusCI's `deploy` task offers deep flexibility to customize your deployment process. Review [](configure-metadata-deployment) for an in-depth guide.
727727

728728
```{toctree}
729729
---

docs/connected-orgs.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -66,25 +66,25 @@ CumulusCI with the name `devhub`.
6666
```console
6767
$ cci org list
6868

69-
Scratch Orgs──────────────┬─────────┬──────┬─────────┬──────────────┬────────┐
69+
Scratch Orgs
7070
│ Name │ Default │ Days │ Expired │ Config │ Domain │
71-
├────────────────────────────────────────────────────────────────────────
71+
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
7272
│ dev │ │ 7 │ X | dev │ │
73-
├────────────────────────────────────────────────────────────────────────
73+
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
7474
│ feature │ │ 1 │ X | feature │ │
75-
├────────────────────────────────────────────────────────────────────────
75+
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
7676
│ prerelease │ │ 1 │ X | prerelease │ │
77-
├────────────────────────────────────────────────────────────────────────
77+
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
7878
│ qa │ │ 7 │ X | qa │ │
79-
├────────────────────────────────────────────────────────────────────────
79+
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
8080
│ release │ │ 1 │ X | release │ │
81-
└──────────────────────────┴─────────┴──────┴─────────┴──────────────┴────────┘
8281

83-
┌Connected Orgs────┬──────────────────────────────┬────────────┐
82+
83+
Connected Orgs
8484
│ Name │ Default │ Username │ Expires │
85-
├───────────────────────────────────────────────────────────
85+
├────────|─────────|──────────────────────────────|────────────-|
8686
│ devhub │ │ j.holt@mydomain.devhub │ Persistent │
87-
└────────┴─────────┴──────────────────────────────┴────────────┘
87+
8888
```
8989

9090
Verify a successful connection to the org by logging in.

docs/data/extract_declarations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ generated by `capture_sample_data` or by Metecho.
1111

1212
An extract declaration looks like this:
1313

14-
```yml
14+
```yaml
1515
extract:
1616
Opportunity:
1717
fields:
@@ -27,7 +27,7 @@ and Account.
2727

2828
That declaration is therefore the same as:
2929

30-
```yml
30+
```yaml
3131
# This will download the Salesforce-y trinity
3232
# of Accounts, Contacts and Opportunities
3333
extract:

docs/deploy.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(configure-metadata-deployment)=
12
# Configure Metadata Deployment
23

34
CumulusCI's `deploy` task uses the Metadata API to deploy metadata from the repository to a Salesforce org. `deploy` offers multiple sophisticated capabilities to suit the needs of your project.
@@ -62,7 +63,7 @@ flows:
6263
replace: bar
6364
```
6465
65-
To learn more about customization, see [](config). To discover the available transform options, consult the section for each transform in [](deploy).
66+
To learn more about customization, see [](config). To discover the available transform options, consult the section for each transform in [](configure-metadata-deployment).
6667
6768
### Namespace Injection
6869

docs/dev.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,15 +161,15 @@ editor, push these changes from your project's local repository to the
161161
target org.
162162

163163
To push your changes, use the
164-
[](deploy) task:
164+
[deploy](configure-metadata-deployment) task:
165165

166166
```console
167167
$ cci task run deploy
168168
```
169169

170170
The `deploy` task has _many_ options for handling a number of different
171171
scenarios. For a comprehensive list of options, see the
172-
[](deploy) task reference.
172+
[deploy](configure-metadata-deployment) task reference.
173173

174174
## Run Apex Tests
175175

0 commit comments

Comments
 (0)