Skip to content
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

Jump to bottom

Fix broken links in documentation #4418

Merged
merged 4 commits into from
Feb 11, 2021
Merged

Fix broken links in documentation #4418

merged 4 commits into from
Feb 11, 2021

Conversation

emmaindal
Copy link
Member

As I was browsing around documentation I found some broken links!

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)

@emmaindal emmaindal requested a review from a team as a code owner February 8, 2021 08:02
@backstage-service backstage-service temporarily deployed to Tugboat February 8, 2021 08:02 Destroyed
@changeset-bot
Copy link

changeset-bot bot commented Feb 8, 2021 •
edited
Loading

⚠️ No Changeset found

Latest commit: 9dc37fb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

OrkoHunter
OrkoHunter approved these changes Feb 8, 2021
View reviewed changes
docs/reference/utility-apis/IdentityApi.md Outdated Show resolved Hide resolved
@backstage-service backstage-service temporarily deployed to Tugboat February 8, 2021 08:15 Destroyed
Rugvip
Rugvip reviewed Feb 8, 2021
View reviewed changes
docs/reference/utility-apis/IdentityApi.md Outdated
@@ -1,7 +1,7 @@
# IdentityApi

The IdentityApi type is defined at
[packages/core-api/src/apis/definitions/IdentityApi.ts:22](https://github.com/backstage/backstage/blob/ca535f2f66c3a4980c80f4b1a049dfd07569010e/packages/core-api/src/apis/definitions/IdentityApi.ts#L22).
[packages/core-api/src/apis/definitions/IdentityApi.ts:22](https://github.com/backstage/backstage/blob/abd85269fbea466c18a71fa661335c0713a32c07/packages/core-api/src/apis/definitions/IdentityApi.ts#L22).
Copy link
Member

Choose a reason for hiding this comment

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

These are generated, use yarn docgen instead

Copy link
Member Author

Choose a reason for hiding this comment

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

oh TIL, there were a lot more then! @Rugvip I wonder if it that command should automatically get ran in some way?

Copy link
Member

Choose a reason for hiding this comment

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

But surprised the links broke tbh, they should be stable :p

Most of the updates are just switching the links to the master sha, which isn't really needed. It just needs updates when changing the core apis

@backstage-service backstage-service temporarily deployed to Tugboat February 8, 2021 16:14 Destroyed
Rugvip
Rugvip approved these changes Feb 10, 2021
View reviewed changes
Copy link
Member

@Rugvip Rugvip left a comment

Choose a reason for hiding this comment

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

:shipit:

@emmaindal emmaindal merged commit a473c6e into master Feb 11, 2021
@emmaindal emmaindal deleted the emmaindal/broken-links-docs branch February 11, 2021 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OrkoHunter OrkoHunter OrkoHunter approved these changes

@Rugvip Rugvip Rugvip approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@emmaindal @Rugvip @OrkoHunter @backstage-service