Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for CLI rename slug task #228

Merged
merged 2 commits into from
Aug 30, 2023
Merged

Add docs for CLI rename slug task #228

merged 2 commits into from
Aug 30, 2023

Conversation

anvit
Copy link
Contributor

@anvit anvit commented Jul 12, 2023

No description provided.

@anvit anvit added admin manual The issue affects content in the Administrator manual new content This issue will add a new section or page to the documentation labels Jul 12, 2023
@anvit anvit self-assigned this Jul 12, 2023
Copy link
Contributor

@fiver-watson fiver-watson left a comment

Choose a reason for hiding this comment

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

Hi! Looks good overall - found one important typo to fix, and also added a few suggestions you can take or leave.

One of those was to add a SEEALSO admonition with some links to related content throughout the docs. If you wanted to add links back to this section in those related areas, you'd find them at the following spots

Generate slugs task

It's right above, but it's also long, has an important overview of how slugs work in AtoM, and people tend to navigate via links and search rather than reading sequentially, so i think it's worth linking. There's already a TIP admonition linking to another section that you could expand, or replace with a more general SEEASLO admonition, at:

Rename module

Generate description permalinks from setting

admin-manual/maintenance/cli-tools.rst Outdated Show resolved Hide resolved
admin-manual/maintenance/cli-tools.rst Show resolved Hide resolved
@anvit anvit requested a review from fiver-watson July 17, 2023 18:32
Copy link
Member

@amayita amayita left a comment

Choose a reason for hiding this comment

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

LGTM

@anvit anvit merged commit 8df64ed into 2.7 Aug 30, 2023
2 checks passed
@anvit anvit deleted the dev/docs-cli-rename-slug branch August 30, 2023 18:29
melaniekung added a commit that referenced this pull request Nov 16, 2023
anvit added a commit that referenced this pull request Nov 20, 2023
* Add docs for CLI rename slug task
* Add links from other related pages, and examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admin manual The issue affects content in the Administrator manual new content This issue will add a new section or page to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants