Skip to content

Updating public docs to reflect GitHub Connections in Platform Hub capabilities and limitations#3062

Open
felixi-octopus wants to merge 2 commits intomainfrom
felix/ghconnections
Open

Updating public docs to reflect GitHub Connections in Platform Hub capabilities and limitations#3062
felixi-octopus wants to merge 2 commits intomainfrom
felix/ghconnections

Conversation

@felixi-octopus
Copy link
Contributor

[sc-135096]

Background

Public documentation lacks information about GitHub Connections in Platform Hub, leaving customers unaware of the feature, how to use it, and what limitations it has.

Result

Updates to reflect GitHub Connections in Platform Hub capabilities and limitations.

To be merged when Platform Hub GitHub Connections is released to Cloud customers.

Copy link
Contributor

@steve-fenton-octopus steve-fenton-octopus left a comment

Choose a reason for hiding this comment

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

Ace. Thank you for fixing those linting errors, too!

### GitHub Connections

The GitHub Connection is not supported in Platform Hub. Only usernames and PATs.
GitHub Connections is supported in the Platform Hub, but it can only be used to configure Platform Hub version control. It can't be used on steps in templates.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
GitHub Connections is supported in the Platform Hub, but it can only be used to configure Platform Hub version control. It can't be used on steps in templates.
GitHub Connections is supported in Platform Hub, but it can only be used to configure Platform Hub version control. It can't be used on steps in templates.

Copy link
Contributor

Choose a reason for hiding this comment

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

I believe because it's a feature name it can be used directly and doesn't need 'the'. We tend to lean towards doing this in the rest of the docs. But @jasminwong may be able to correct me on this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed!


You can currently use GitHub App Connections to connect to Configuration as Code projects. This removes the need for using Personal Access Tokens to connect to GitHub repositories, and allows users to commit as their GitHub users (rather than using a shared account).

You can also define GitHub Connections in the [Platform Hub](/docs/platform-hub). GitHub Connections defined in the Platform Hub can only be used to configure the Platform Hub's version control settings and can't be used in spaces.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
You can also define GitHub Connections in the [Platform Hub](/docs/platform-hub). GitHub Connections defined in the Platform Hub can only be used to configure the Platform Hub's version control settings and can't be used in spaces.
You can also define GitHub Connections in [Platform Hub](/docs/platform-hub). GitHub Connections defined in Platform Hub can only be used to configure Platform Hub's version control settings and can't be used in spaces.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed!

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.

3 participants