Skip to content

Conversation

@shariff-6
Copy link
Contributor

Description

This PR adds documentation about the path field capabilities for the GitLab-v2 file kind integration. Previously, this information was only available in the migration guide, making it difficult for users starting with GitLab-v2 to understand what patterns are supported.

The changes include:

  • Added detailed info admonition in the main GitLab-v2 documentation explaining supported patterns (simple wildcards, exact paths) and unsupported patterns (path wildcards, recursive patterns, complex patterns)
  • Added brief inline comment in the example package config file for quick reference when viewing examples

This addresses the missing information about path field capabilities and helps users understand the limitations of GitLab's Advanced Search syntax when configuring file ingestion.

Added docs pages

None

Updated docs pages

  • GitLab-v2 (/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2)
  • GitLab-v2 Examples (/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/examples)

Add path field documentation explaining supported patterns (simple
wildcards, exact paths) and limitations (no path wildcards, recursive
patterns, or complex patterns) in both the main docs and example file.
@aws-amplify-eu-west-1
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-3187.d2ngvl90zqbob8.amplifyapp.com

Copy link
Member

@mk-armah mk-armah left a comment

Choose a reason for hiding this comment

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

LGTM


The `file` kind follows [GitLab's Advanced Search type](https://docs.gitlab.com/ee/user/search/advanced_search.html#:~:text=Advanced%20search%20is%20based%20on,Projects/), adhering to its syntax, limitations, and capabilities.

:::info Path field capabilities
Copy link
Contributor

Choose a reason for hiding this comment

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

Admonitions should be used to present important information that we want to pop out relative to other text on the page.

Also, we never want to have multiple admonitions in a row.

In this case, the "Path field capabilities" should be a header and not an admonition, it is classic text and not something that warrants a callout.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you hadar for the feedback. Learn something everyday. Okay I'll make the changes and revert

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants