updated paths to API reference, changelog, and specs in automation#1247
updated paths to API reference, changelog, and specs in automation#1247mikeromard wants to merge 2 commits into
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
| historicalVersionCutoff: "2024-05-24" | ||
| syncStateFile: tools/api-docs-generator/sync-state.yml | ||
| changelogFile: docs/snyk-api/changelog.md | ||
| changelogFile: developer-tools/snyk-api/changelog.md |
There was a problem hiding this comment.
@mikeromard it might be worth copying the changelog from docs/snyk-api/changelog.md to developer-tools/snyk-api/changelog.md, as it seems there is a bit of a difference
There was a problem hiding this comment.
On it! We're copying all changes that have been made since the migration started. I've got another PR open for that
| - name: import-projects-v1 | ||
| hint: | | ||
| You can use this API to import projects into Snyk. Projects imported can be Git repositories, Docker images, containers, configuration files, and much more. See the [Projects and Targets documentation](../../snyk-platform-administration/snyk-projects/#target) for more information. A typical import would start with requesting a target to be processed and then polling the Import Job API for more details on completion of an import and the resulting Snyk Projects. | ||
| You can use this API to import projects into Snyk. Projects imported can be Git repositories, Docker images, containers, configuration files, and much more. See the [Projects and Targets documentation](https://app.gitbook.com/o/-M4tdxG8qotLgGZnLpFR/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-projects#target) for more information. A typical import would start with requesting a target to be processed and then polling the Import Job API for more details on completion of an import and the resulting Snyk Projects. |
There was a problem hiding this comment.
Any reason why this hardcodes the full URL vs using relative paths?
There was a problem hiding this comment.
Yeah, it's because the page being linked to will be in a different site section than the page this link will appear on, and the relative path won't work
malinbranduse
left a comment
malinbranduse
left a comment
There was a problem hiding this comment.
pre-approving considering the changelog needs to be migrated over to developer-tools as well prior to merging
2 participants
Updated the path to the API reference, changelog, and spec source files in the automation to point to the new location. This PR should not be merged prior to the site sections going live on May 28.