Skip to content

Merging CE and EE API docs together

Marcel Amirault requested to merge (removed):docs-api-merge-1 into master

What does this MR do?

Ported to EE in https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/14058

This is a test MR to see how it would look to merge CE and EE API docs together using different methods. There are 5 examples, separated into two styles:

EDIT: This is an attempt to merge more ALL remaining api docs from EE into CE, using the second style listed below.

  1. DELETED

  2. Make the main json response CE only, and include a note after it showing what would be included if it was an EE json response.

    • group_boards.md
    • projects.md
    • protected_branches.md
    • groups.md
    • settings.md
    • merge_requests.md
    • issues.md
    • group_milestones.md (recently diverged again)
    • milestones.md (recently diverged again)
    • users.md
    • notification_settings.md
    • namespaces.md

Related issues

Related to https://gitlab.com/gitlab-org/gitlab-ce/issues/60045

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcel Amirault

Merge request reports