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

feat: Add new techdocs-rewrite-relative-links-action #99

Merged
merged 30 commits into from
May 2, 2024
Merged

feat: Add new techdocs-rewrite-relative-links-action #99

merged 30 commits into from
May 2, 2024

Conversation

zerok
Copy link
Contributor

@zerok zerok commented Apr 18, 2024

This should help improve our internal techdoc generation and will most likely be part of the publish-techdocs workflow.

@zerok zerok force-pushed the zerok/techdocs-rewrite-relative-links-action branch 5 times, most recently from 592999d to 089d7ab Compare April 18, 2024 11:34
@zerok zerok marked this pull request as ready for review April 19, 2024 07:06
@zerok zerok requested a review from a team as a code owner April 19, 2024 07:06
@zerok
Copy link
Contributor Author

zerok commented Apr 19, 2024

The diff in https://github.com/grafana/deployment_tools/actions/runs/8734877664/job/23973857969 looks actually quite sane! 🙂

  • emph with _ is replaced with * (due to markdown re-rendering)
  • indentation is normalized incl. line endings (due to markdown re-rendering)
  • relative links to files point to blob
  • relative links to folders point to tree

iainlane
iainlane reviewed Apr 19, 2024
View reviewed changes
Copy link
Member

@iainlane iainlane left a comment

Choose a reason for hiding this comment

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

nice work!

here are a bunch of mostly optional / quality-of-life suggestions. do the ones that make sense to do now, and you can make issues or dismiss the rest 😁

actions/techdocs-rewrite-relative-links/main_test.go Outdated Show resolved Hide resolved
actions/techdocs-rewrite-relative-links/main_test.go Outdated Show resolved Hide resolved
actions/techdocs-rewrite-relative-links/main_test.go Show resolved Hide resolved
actions/techdocs-rewrite-relative-links/main_test.go Show resolved Hide resolved
actions/techdocs-rewrite-relative-links/main.go Outdated Show resolved Hide resolved
actions/techdocs-rewrite-relative-links/main.go Outdated Show resolved Hide resolved
actions/techdocs-rewrite-relative-links/main.go Outdated Show resolved Hide resolved
.github/workflows/publish-techdocs.yaml Outdated Show resolved Hide resolved
actions/techdocs-rewrite-relative-links/main.go Show resolved Hide resolved
actions/techdocs-rewrite-relative-links/README.md Outdated Show resolved Hide resolved
@zerok zerok force-pushed the zerok/techdocs-rewrite-relative-links-action branch 6 times, most recently from 924e8b7 to a5c22e8 Compare April 29, 2024 12:59
@zerok zerok requested a review from iainlane April 30, 2024 13:40
iainlane
iainlane approved these changes May 1, 2024
View reviewed changes
Copy link
Member

@iainlane iainlane left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice 👍 TIL about afero. Couple of suggestions but let's give this a go, thanks!

Suggest rebasing on (or reviewing) #108 first so that we don't get more drift 😁 edit:merged now

actions/techdocs-rewrite-relative-links/action.yaml Outdated Show resolved Hide resolved
actions/techdocs-rewrite-relative-links/action.yaml Outdated Show resolved Hide resolved
@zerok zerok force-pushed the zerok/techdocs-rewrite-relative-links-action branch from a5c22e8 to dfa05b6 Compare May 2, 2024 06:49
@zerok
Copy link
Contributor Author

zerok commented May 2, 2024

Nice 👍 TIL about afero. Couple of suggestions but let's give this a go, thanks!

Suggest rebasing on (or reviewing) #108 first so that we don't get more drift 😁 edit:merged now

Done :)

@zerok zerok merged commit 93c8404 into main May 2, 2024
4 checks passed
@zerok zerok deleted the zerok/techdocs-rewrite-relative-links-action branch May 2, 2024 07:17
This was referenced Jul 15, 2024
Closed
Merged
@github-actions github-actions bot mentioned this pull request Sep 26, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iainlane iainlane iainlane 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.
2 participants
@zerok @iainlane