Skip to content

W-18185062#3891

Merged
jstvz merged 1 commit intoSFDO-Tooling:mainfrom
dcinzona:docs/pdf
Apr 9, 2025
Merged

W-18185062#3891
jstvz merged 1 commit intoSFDO-Tooling:mainfrom
dcinzona:docs/pdf

Conversation

@dcinzona
Copy link
Copy Markdown
Contributor

@dcinzona dcinzona commented Apr 3, 2025

  • Setting latex engine to help with ReadTheDocs PDF generation (missing unicode characters using default engine)
  • Fixing Pygments errors for robotframework syntax in markdown
  • Fixing invalid sample code in robot.md

@dcinzona dcinzona requested a review from a team as a code owner April 3, 2025 23:50
@salesforce-cla
Copy link
Copy Markdown

salesforce-cla Bot commented Apr 3, 2025

Thanks for the contribution! It looks like @dcinzona is an internal user so signing the CLA is not required. However, we need to confirm this.

@dcinzona
Copy link
Copy Markdown
Contributor Author

dcinzona commented Apr 4, 2025

  • Changed doc author back to CumulusCI Suite Dev Team and added project email
  • Fixed broken document references
  • Removed history.md from PDF generation This was causing PDF bloat and introduced multiple broken references
  • Removed emojis from documentation

Copy link
Copy Markdown
Contributor

@jstvz jstvz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dcinzona Thanks for the PR. One question and some tweaks requested.

Comment thread cumulusci/tasks/release_notes/task.py
Comment thread docs/conf.py Outdated
Comment thread docs/connected-orgs.md
Comment thread docs/continuous-integration.md Outdated
CumulusCI makes it easy to harness the power of second-generation
managed packages to implement an advanced, comprehensive testing process
for both first- and second-generation managed package products. This is
for both first and second-generation managed package products. This is
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: If the hanging hyphen is tripping us up, let's go with the more verbose but still correct:

Suggested change
for both first and second-generation managed package products. This is
for both first-generation and second-generation managed package products. This is

Comment thread docs/data.md Outdated

Example:
```console
cci task run extract_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cci task run extract_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa
cci task run extract_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa

Comment thread docs/connected-orgs.md
Comment on lines -69 to +83
Scratch Orgs──────────────┬─────────┬──────┬─────────┬──────────────┬────────┐
Scratch Orgs
│ Name │ Default │ Days │ Expired │ Config │ Domain │
├────────────────────────────────────────────────────────────────────────
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
│ dev │ │ 7 │ X | dev │ │
├────────────────────────────────────────────────────────────────────────
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
│ feature │ │ 1 │ X | feature │ │
├────────────────────────────────────────────────────────────────────────
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
│ prerelease │ │ 1 │ X | prerelease │ │
├────────────────────────────────────────────────────────────────────────
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
│ qa │ │ 7 │ X | qa │ │
├────────────────────────────────────────────────────────────────────────
├──────────────────────────|─────────|──────|─────────|──────────────|────────-|
│ release │ │ 1 │ X | release │ │
└──────────────────────────┴─────────┴──────┴─────────┴──────────────┴────────┘

┌Connected Orgs────┬──────────────────────────────┬────────────┐

Connected Orgs
│ Name │ Default │ Username │ Expires │
├───────────────────────────────────────────────────────────
├────────|─────────|──────────────────────────────|────────────-|
│ devhub │ │ j.holt@mydomain.devhub │ Persistent │
└────────┴─────────┴──────────────────────────────┴────────────┘

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update to match the current output:

$ cci org list
                         Scratch Orgs

  Default   Name         Days   Expired   Config       Domain
 ─────────────────────────────────────────────────────────────
            beta         1                beta
            dev          7      ✔         dev
            feature      1                feature
            qa           7      ✔         qa
            release      1                release

                                     Connected Orgs

  Default   Name                 Username                                    Expires
 ───────────────────────────────────────────────────────────────────────────────────────
            devhub       j.holt@mydomain.devhub                    Persistent

Comment thread docs/continuous-integration.md Outdated
CumulusCI makes it easy to harness the power of second-generation
managed packages to implement an advanced, comprehensive testing process
for both first- and second-generation managed package products. This is
for both first and second-generation managed package products. This is
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More verbose, but grammar:

Suggested change
for both first and second-generation managed package products. This is
for both first-generation and second-generation managed package products. This is

Comment thread docs/data.md Outdated

Example:
```console
cci task run extract_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop leading spaces since we're using fences:

Suggested change
cci task run extract_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa
cci task run extract_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa

Comment thread docs/data.md Outdated
Example:

```console
cci task run load_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cci task run load_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa
cci task run load_dataset -o mapping datasets/qa/mapping.yml -o sql_path datasets/qa/data.sql --org qa

Comment thread docs/data.md Outdated
Example:

```console
cci task run generate_dataset_mapping --org qa -o namespace_prefix my_ns
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cci task run generate_dataset_mapping --org qa -o namespace_prefix my_ns
cci task run generate_dataset_mapping --org qa -o namespace_prefix my_ns

Removing python install from .readthedocs.yml

Fixing doc broken references

Fixing broken references in documentation and removing unicode emojis from doc gen

Applying recommended PR changes
Copy link
Copy Markdown
Contributor

@jstvz jstvz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for the fix.

@jstvz jstvz merged commit 769028b into SFDO-Tooling:main Apr 9, 2025
20 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants