Skip to content

Fix links between patterns#214

Merged
lenucksi merged 10 commits intoInnerSourceCommons:masterfrom
spier:fix-links-in-structured-patterns
Sep 22, 2020
Merged

Fix links between patterns#214
lenucksi merged 10 commits intoInnerSourceCommons:masterfrom
spier:fix-links-in-structured-patterns

Conversation

@spier
Copy link
Copy Markdown
Member

@spier spier commented Sep 20, 2020

While working on creating a book out of our patterns I noticed that some reference from one pattern to another pattern were broken. (side note: Maybe we can call these inter-pattern links? :))

That issue was likely introduced when we moved around the patterns into the new maturity structure with the 3 subfolders below patterns.

Fix:

  • modified the link check to also check everything in the patterns folder.
  • manually updated the inter-pattern links to point to the correct files

@spier
Copy link
Copy Markdown
Member Author

spier commented Sep 20, 2020

I updated all the broken links that I could. However there are still two issues now:

sample link in patterns/2-structured/praise-participants.md

This pattern provides a text-snippet sample to demo how to praise participants for their contribution.
In there we have a link to https://github.com/rcs/rcs-viewer/pull/81. That link does not exist.

Possible fixes:

  • remove the link completely
  • use a different example (and a working link) for praising participants

Network timeout to http://www.fearlesschangepatterns.com

The link to http://www.fearlesschangepatterns.com times out every once in a while. Probably just a slow host.

Possible fixes:

  • exclude this link from the check? (i.e. adding it to the list of ignored links for the liche link checker)

@lenucksi
Copy link
Copy Markdown
Member

I updated all the broken links that I could. However there are still two issues now:

sample link in patterns/2-structured/praise-participants.md

This pattern provides a text-snippet sample to demo how to praise participants for their contribution.
In there we have a link to https://github.com/rcs/rcs-viewer/pull/81. That link does not exist.

Possible fixes:

* remove the link completely

* use a different example (and a working link) for praising participants

Sounds like a good idea. Do we possibly have one in our own repos? Maybe @rrrutledge might know a good example.

Network timeout to http://www.fearlesschangepatterns.com

The link to http://www.fearlesschangepatterns.com times out every once in a while. Probably just a slow host.

Possible fixes:

* exclude this link from the check? (i.e. adding it to the list of ignored links for the `liche` link checker)

Sound good to me. Slow servers exist.

Copy link
Copy Markdown
Member

@lenucksi lenucksi left a comment

Choose a reason for hiding this comment

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

Great stuff, thanks for finding & fixing this. Added a suggestions for the open items. Happy to merge once those are solved.

@spier
Copy link
Copy Markdown
Member Author

spier commented Sep 21, 2020

@lenucksi I ended up fixing things differently.

  • updated fearlesschangepatterns.com from http to https (that made the link checker happy)
  • added https://github.com/rcs/rcs-viewer/pull/81 to the ignore list of the link checker, as this link is only used in an example of a praise message anyways, and could as well be removed.

Once this PR gets merged, all links in the files in the patterns directory will get checked for broken links.

Copy link
Copy Markdown
Member

@lenucksi lenucksi left a comment

Choose a reason for hiding this comment

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

LGTM

@lenucksi lenucksi merged commit 8cd81f9 into InnerSourceCommons:master Sep 22, 2020
@spier spier deleted the fix-links-in-structured-patterns branch September 22, 2020 11:54
@lenucksi lenucksi added Type - Maintenance / Cleanup Maintaining / cleaning the repo is the main focus of this issue / PR (Self-) Hosting Everything around artifact rendering and presentation. labels Sep 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

(Self-) Hosting Everything around artifact rendering and presentation. Type - Maintenance / Cleanup Maintaining / cleaning the repo is the main focus of this issue / PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants