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.

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

Update link to GitHub GQM graph page #53

Merged
merged 2 commits into from
Jan 25, 2024
Merged

Conversation

rrrutledge
Copy link
Contributor

@rrrutledge rrrutledge commented Oct 23, 2023

  • The graph links only work in GitHub.
  • Because of that we want to have a link in the book back to GitHub.
  • For some reason the link in the book points to the page in the book.
  • Maybe GitBook is auto-replacing GitHub links to point to the corresponding GitBook page instead.
  • Hopefully this Bitly link won't get so-replaced.

* The graph links only work in GitHub.
* Because of that we want to have a link in the book back to GitHub.
* For some reason the link in the book points to the page in the book.
* Maybe GitBook is auto-replacing GitHub links to point to the corresponding GitBook page instead.
* Hopefully this Bitly link won't get so-replaces.
@rrrutledge rrrutledge requested a review from spier October 23, 2023 20:08
@rrrutledge rrrutledge requested a review from a team as a code owner October 23, 2023 20:08
@spier
Copy link
Member

spier commented Oct 23, 2023

An easier way to try this out would be to make the change in app.gitbook.com direct, I think they call it a change request, and then discard that again.

@spier
Copy link
Member

spier commented Oct 23, 2023

Btw I think this is a shortcoming of the mermaidjs integration in gitbook. So my suspicion is that you won't be able to fix this.

@rrrutledge
Copy link
Contributor Author

make the change in app.gitbook.com direct, I think they call it a change request

OK check this out: https://app.gitbook.com/o/-MBYS3fpZ77O90pglFWi/s/-M3b_yGIW5Sz9pObaJm5/~/diff/~/changes/6/measuring/goals/use_gqm

@spier
Copy link
Member

spier commented Oct 27, 2023

Ah. I had misunderstood this PR. Thought it was about changing the links that are embedded within the graph.

About the issue

When gitbook sees a link that it already knows from the SUMMARY.md, then it will turn that link to an internal link within the gitbook instance. That's why you saw this translation:

From https://github.com/InnerSourceCommons/managing-inner-source-projects/blob/master/measuring/use_gqm.md
To https://innersourcecommons.gitbook.io/managing-innersource-projects/measuring/goals/use_gqm

So if you want to force a link back to the original markdown file, then your approach with a bitly link should work.

As an aside:

I cannot see the bitly link in your change request in gitbook. For me it still looks like you are pointing to https://github.com/InnerSourceCommons/managing-innersource-projects/blob/main/measuring/use_gqm.md.

However that link does magically work right now, as we renamed master to main :)
Gitbook does not realize that those are the same links.

Will file a separate issue/PR to change all links embedded in the content from master to main.

@rrrutledge
Copy link
Contributor Author

OK let’s just go with this Bitly approach, then?

@rrrutledge
Copy link
Contributor Author

Copy link
Contributor

@JustinGOSSES JustinGOSSES left a comment

Choose a reason for hiding this comment

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

Looks good, lets try bitly

@jeffabailey jeffabailey linked an issue Dec 16, 2023 that may be closed by this pull request
5 tasks
@jeffabailey jeffabailey merged commit 939c3a4 into main Jan 25, 2024
@jeffabailey jeffabailey deleted the rrrutledge-patch-1 branch January 25, 2024 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automate creation of the GQM diagram
4 participants