Skip to content

Add GitLab onboarding bypass instructions #754

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add GitLab onboarding bypass instructions #754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d63401e
Documentation edits made through Mintlify web editor
mintlify[bot] May 28, 2025
67d0673
Documentation edits made through Mintlify web editor
mintlify[bot] May 28, 2025
c7d2e3b
Documentation edits made through Mintlify web editor
mintlify[bot] May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion settings/gitlab.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@ automatically trigger deployments.
[here](https://mintlify.com/enterprise).
</Note>

[git-settings]: https://dashboard.mintlify.com/settings/deployment/git-settings
[git-settings]: https://dashboard.mintlify.com/settings/deployment/git-settings
35 changes: 35 additions & 0 deletions support.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,41 @@ export function openSearch(e) {
3. Paste the code into your card. Make sure you only copy and paste the code inside the `<svg/>` tag.
4. You may need to decrease the height and width to make the image fit.
</Accordion>

<Accordion title="Bypassing the Onboarding Flow for GitLab" icon="gitlab">
Since account creation is currently limited to GitHub, you'll need to use a workaround to connect your GitLab repository. Follow these steps to bypass the standard GitHub-only onboarding flow:

<Steps>
<Step title="Skip the first onboarding step">
When you first create your Mintlify account, you'll see an onboarding flow that asks you to connect a GitHub repository. Skip this initial step.
<Frame>
<img src="/images/gitlab/skip-onboarding-step.png" alt="Skipping the first onboarding step that asks for GitHub repository connection" />
</Frame>
</Step>
<Step title="Enter placeholder repository information">
In the second step of the onboarding process, enter the following placeholder information:
- Organization: `mintlify`
- Repository: `starter`

This will allow you to proceed through the onboarding without connecting an actual GitHub repository.
<Frame>
<img src="/images/gitlab/placeholder-repo-info.png" alt="Entering 'mintlify' as organization and 'starter' as repository name in the onboarding form" />
</Frame>
</Step>
<Step title="Complete the onboarding">
Click through the remaining onboarding steps to reach your Mintlify dashboard.
<Frame>
<img src="/images/gitlab/complete-onboarding.png" alt="Clicking through the final onboarding steps to reach the Mintlify dashboard" />
</Frame>
</Step>
<Step title="Navigate to GitLab settings">
Once you're in the dashboard, navigate to the [GitLab settings page](https://dashboard.mintlify.com/settings/deployment/git-settings) and connect your actual GitLab repository using the project ID and access token from the previous section.
<Frame>
<img src="/images/gitlab/navigate-gitlab-settings.png" alt="Navigating to the GitLab settings page in the Mintlify dashboard" />
</Frame>
</Step>
</Steps>
</Accordion>
</AccordionGroup>

<Info>
Expand Down
Loading