8000 Merge pull request #3172 from port-labs/PORT-16969-bug-github-ocean-d… · port-labs/port-docs@9d50cc7 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9d50cc7

Browse files
sivanel97sivanel97
authored
Merge pull request #3172 from port-labs/PORT-16969-bug-github-ocean-docs-are-busy-and-not-easily-consumed
Merging the changes done so far, there is still work to be done in regards to the structural changes, Iv'e discussed this with Maya Margalit, Matan Geva and Hadar Cohen. Will follow up in the next couple of weeks for further changes.
2 parents 1f34e2e + 789fb1a commit 9d50cc7

File tree

31 files changed

+946
-937
lines changed

31 files changed

+946
-937
lines changed

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/capabilities.md‎

Lines changed: 764 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples.md‎

Lines changed: 21 additions & 19 deletions
< 9E88 td data-grid-cell-id="diff-ea9054d803a20d9b6585a0dffa6b55b4ae7504c6b08fbbc3dfe97b6dae34ce17-136-138-1" data-selected="false" role="gridcell" style="background-color:var(--bgColor-default);text-align:center" tabindex="-1" valign="top" class="focusable-grid-cell diff-line-number position-relative diff-line-number-neutral left-side">138
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 4
33
---
44

55
import RepositoryBlueprint from './examples/\_github_exporter_example_repository_blueprint.mdx'
@@ -55,9 +55,11 @@ import OrganizationBlueprint from './examples/example-organization/\_github_expo
5555
import OrganizationAppConfig from './examples/example-organization/\_github_exporter_example_organization_port_app_config.mdx'
5656

5757

58-
# Resource mapping examples
58+
# Examples
5959

60-
## Map organizations and repositories
60+
This page provides practical examples for mapping various GitHub resources to Port.
61+
62+
## Organizations and repositories
6163

6264
:::info Available from v3.0.0-beta
6365
The `organization` kind is available from version `v3.0.0-beta` onwards.
@@ -82,7 +84,7 @@ You can use the following Port blueprint definitions and `port-app-config.yml`:
8284

8385
After creating the blueprints and committing the `port-app-config.yml` file, you will see new entities in Port matching your organizations and their repositories. The repositories will have a relation to their parent organization.
8486

85-
## Map repositories and pull requests
87+
## Repositories and pull requests
8688

8789
The following example demonstrates how to ingest your GitHub repositories, their README.md file contents and open pull requests to Port.
8890
You can use the following Port blueprint definitions and `port-app-config.yml`:
@@ -116,7 +118,7 @@ Additionally, you can configure your selector to limit the number of closed pull
116118
```
117119
118120
119-
## Map repositories and issues
121+
## Repositories and issues
120122
121123
The following example demonstrates how to ingest your GitHub repositories and their issues to Port, you may use the following Port blueprint definitions and `port-app-config.yml`:
122124

@@ -136,7 +138,7 @@ The following example demonstrates how to ingest your GitHub repositories and th
136

137139
:::
138140

139-
## Map repositories and branches
141+
## Repositories and branches
140142

141143
The following example demonstrates how to ingest your GitHub repositories and their branches to Port, you may use the following Port blueprint definitions and `port-app-config.yml`:
142144

@@ -146,7 +148,7 @@ The following example demonstrates how to ingest your GitHub repositories and th
146148

147149
<PortBrAppConfig/>
148150

149-
## Map files and file contents
151+
## Files and file contents
150152

151153
The following example demonstrates ingestion of dependencies from a `package.json` file in your repository into Port:
152154

@@ -157,15 +159,15 @@ The example will parse the `package.json` file in your repository and extract th
157159
For more information about ingesting files and file contents, click [here](/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/#ingest-files-from-your-repositories).
158160

159161

160-
## Map files and repositories
162+
## Files and repositories
161163

162164
The following example demonstrates mapping files to repository.
163165

164166
<RepositoryBlueprint />
165167
<FileBlueprint />
166168
<RepoFileAppConfig />
167169

168-
## Map repositories and monorepos
170+
## Repositories and monorepos
169171

170172
The following example demonstrates how to ingest your GitHub repositories and their folders to Port. By following this example you can map your different services, packages and libraries from your monorepo into separate entities in Port. You may use the following Port blueprint definitions and `port-app-config.yml`:
171173

@@ -205,7 +207,7 @@ Use `path` and `repositoryType` to scope results and improve performance.
205207
:::
206208

207209

208-
## Map repositories, workflows and workflow runs
210+
## Repositories, workflows and workflow runs
209211

210212
The following example demonstrates how to ingest your GitHub repositories, their workflows and workflow runs to Port, you may use the following Port blueprint definitions and `port-app-config.yml`:
211213

@@ -223,7 +225,7 @@ The following example demonstrates how to ingest your GitHub repositories, their
223225

224226
:::
225227

226-
## Map repositories and teams
228+
## Repositories and teams
227229

228230
The following example demonstrates how to ingest your GitHub repositories and their teams to Port.
229231
You can use the following Port blueprint definitions and `port-app-config.yml`:
@@ -235,7 +237,7 @@ You can use the following Port blueprint definitions and `port-app-config.yml`:
235237
<PortRepositoryTeamMappingAppConfig/>
236238

237239

238-
## Map repositories with multiple relationships
240+
## Repositories with multiple relationships
239241

240242
You can now include multiple relationship types in a single repository configuration. For example, to include both teams and collaborators:
241243

@@ -279,7 +281,7 @@ While you can include multiple relationship types in a single configuration, thi
279281
:::
280282

281283

282-
## Map teams and team members
284+
## Teams and team members
283285

284286
The following shows how we can map teams and team members using the "members" selector.
285287

@@ -288,7 +290,7 @@ The following shows how we can map teams and team members using the "members" se
288290
<TeamMemberConfig />
289291

290292

291-
## Map repositories, repository admins and users
293+
## Repositories, repository admins and users
292294

293295
The following example demonstrates how to ingest your GitHub repositories, their admins and related users to Port.
294296
You can use the following Port blueprint definitions and `port-app-config.yml`:
@@ -315,7 +317,7 @@ For the `user` kind, only the following fields are supported: `.name`, `.login`,
315317
Other fields from the [GitHub User API](https://docs.github.com/en/rest/users/users#get-a-user) are not available.
316318
:::
317319

318-
## Map repositories and collaborators
320+
## Repositories and collaborators
319321

320322
The following example demonstrates how to ingest your GitHub repositories and their collaborators to Port.
321323
You can use the following Port blueprint definitions and `port-app-config.yml`:
@@ -324,7 +326,7 @@ You can use the following Port blueprint definitions and `port-app-config.yml`:
324326
<CollaboratorBlueprint />
325327
<PortRepositoryCollaboratorAppConfig />
326328

327-
## Map repositories, dependabot alerts, code and secrets scan alerts
329+
## Repositories, dependabot alerts, code and secrets scan alerts
328330

329331
The following example shows how to ingest your GitHub repositories and their alerts (Dependabot and Code scan alerts) into Port. You can use the following Port blueprint definitions and `port-app-config.yml`:
330332

@@ -338,7 +340,7 @@ The following example shows how to ingest your GitHub repositories and their ale
338340

339341
<PortRepositoryDependabotAlertMappingAppConfig/>
340342

341-
## Map repositories, deployments and environments
343+
## Repositories, deployments and environments
342344

343345
The following example demonstrates how to ingest your GitHub repositories, their deployments and environments to Port, you may use the following Port blueprint definitions and `port-app-config.yml`:
344346

@@ -350,7 +352,7 @@ The following example demonstrates how to ingest your GitHub repositories, their
350352

351353
<PortRepoDeploymentAndEnvironmentAppConfig/>
352354

353-
## Map repositories, repository releases and tags
355+
## Repositories, repository releases and tags
354356

355357
The following example demonstrates how to ingest your GitHub repositories, their releases and tags to Port, you may use the following Port blueprint definitions and `port-app-config.yml`:
356358

@@ -362,7 +364,7 @@ The following example demonstrates how to ingest your GitHub repositories, their
362364

363365
<RepositoryTagReleaseAppConfig/>
364366

365-
## Map supported resources
367+
## Supported resources
366368

367369
The examples above show specific use cases, but Port's GitHub integration supports the ingestion of many other GitHub objects.
368370
To adapt the examples above, use the GitHub API reference to learn about the available fields for the different supported objects:

0 commit comments

Comments
 (0)
0