Add context to the start of the Import API page
What does this MR do?
Related to: #322983 (closed), it's not clear which importers provide APIs, so gives the impression that some importers have an undocumented API.
Looking at https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/api, it appears there is only two:
- https://gitlab.com/gitlab-org/gitlab/-/blob/f5852b79f110754d88cf52423ae9a992958e439d/lib/api/import_bitbucket_server.rb
- https://gitlab.com/gitlab-org/gitlab/-/blob/f5852b79f110754d88cf52423ae9a992958e439d/lib/api/import_github.rb
There doesn't appear to be any in: https://gitlab.com/gitlab-org/gitlab/-/tree/master/ee/lib/api or https://gitlab.com/gitlab-org/gitlab/-/tree/master/ee/lib/ee/api (at least not following the import_*.rb filename pattern).
- Before: https://docs.gitlab.com/ee/api/import.html
- After: https://main-ee-113789.docs.gitlab-review.app/ee/api/import.html
While I was here, I've pushed anything GitHub-related in under the first GitHub section, to re-enforce that there are two main sections of the documentation.
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"~"backend"~"type::bug"~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior, say something likeDefault behavior when you close an issue. -
The headings (other than the page title) should be active. Instead of Configuring GDK, say something likeConfigure GDK. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.