Skip to content

Specify category slug and order on creation #785

@garrett-wade

Description

@garrett-wade

In our CI/CD pipeline, we are syncing documents from Project 1 to Project 2. However, we have encountered an issue with category names and slugs not matching between the two projects.

Currently, when creating a category in Project 1, the category name and slug generally match, unless there is a duplicate where it appends -1. This works fine until we have to change the category name in Project 1, which does not update the slug. As a result, when we create the same category in Project 2, the names will match but the slugs will not, causing issues when uploading documents as each document can only have one categorySlug.

To alleviate this, we propose specifying the category slug when creating a category to ensure the match between projects, even if the category name differs. This will prevent the issue of duplicated slugs and allow us to sync documents seamlessly between projects.

Furthermore, we want to preserve the category order between projects, which can only be done through the admin UI. We propose adding functionality to our CI/CD pipeline to allow us to specify the category order programmatically.

We believe these changes will improve our workflow and streamline our document syncing process between projects.

Metadata

Metadata

Assignees

No one assigned

    Labels

    APIUnderlying issue is with the ReadMe API and not necessarily the `rdme` client itselfcommand:pagesIssues pertaining to page upload commands (e.g., `docs`, `reference`, `changelog`, `custompages`)enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions