-
Notifications
You must be signed in to change notification settings - Fork 4
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
Additonal corrections #3
Conversation
Version numbersMat has created I propose to change all occurrences of version numbers related to the GCT as a whole to these attributes respectively due to the following advantages:
Inter-document linksInter-document links are currently mainly linking to the HTML version of an AsciiDoc file. As a result, they for example don't work "correctly" in the rendered AsciiDoc files on GitHub. AsciiDoctor allows something similar called "Inter-document Cross References" that will be adapted to the desired target format, i.e. link to HTML files in the HTML output only - IIUC. But there are some specifics we need to anticipate: E.g. for fragments when relative paths are used for inter-doc. cross references (ICRs) - and I haven't yet found out how to use absolute paths for ICRs - the relative path to the referenced document needs to be chosen based on the location of the AsciiDoc file that includes the fragment and not based on the fragment's location. This makes a problem for fragments that are included in multiple documents which are itself located in different locations. What do you think? |
gsiopenssh/developer/index.adoc
Outdated
@@ -14,7 +14,7 @@ This document provides information for GSI-OpenSSH developers. | |||
The changes to http://www.openssh.org/[OpenSSH] to add GSI support are | |||
limited, because we build on the existing GSSAPI support in OpenSSH for | |||
Kerberos. See the | |||
http://dev.globus.org/wiki/GSI-OpenSSH/Internals[GSI-OpenSSH Internals] | |||
https://web.archive.org/web/20130607001903/http://dev.globus.org:80/wiki/GSI-OpenSSH/Internals[GSI-OpenSSH Internals] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't we refer to https://github.com/globus/gsi-openssh/wiki/Internals
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. I didn't knew this document was moved to the wiki of GSI-OpenSSH on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we allow "rewriting history"? I.e. should I squash the change of the URL in the original commit (not sure if this code comment will then cease to exist) or should I create a new one for this change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think if you just commit to your 'corrections' branch, the pull request will get updated automatically.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, but we'll have another commit cluttering the history then. If we don't care that'd be the easiest way I think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either way is fine with me. Feel free to squash them in your branch (even if this conversation disappears as a result) or leave it as two commits.
We shouldn't squash in the actual gct-docs repo though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm OK with that.
Concerning the fragments / links, would it work to start the links with a / i.e. to make them absolute paths? See e.g. asciidoctor issue #844 |
Me neither, I'm just testing various options. At least on GitHub the "start with a slash" method seems to work, see https://github.com/fscheiner/gct-docs/blob/c8fa6589dcaf3ddd3678f69d45806123dc087e34/myproxy/Cred_Mgmt_MyProxy_Usage_Statistics_Frag.adoc ( |
Looks like the "start with a slash" method does not work when the HTML files are served from GitHub pages, see https://fscheiner.github.io/gct-docs/myproxy/admin/index.html#myproxy-usage (does serve the |
Hmm, I think it interprets them as anchor names, not as paths. From asciidoc-reference-check (under supported-anchors-and-references) I would say you either need to add |
I did some testing and had some further reading, thanks for the links. To me it now looks like the asciidoctor documentation I referenced earlier is not correct in regard to inter-document cross references, because all tests I did with both forms ( With the So all in all no additional value to just directly link to the html files for the cases (1) viewing the AsciiDoc source on GitHub and (2) serving HTML from GitHub. I haven't yet examined how this will behave for PDF output but will keep things as is for now for inter-document links until we find a better solution. @matyasselmeci @ellert @msalle |
Hi Frank, |
Yeah, that's also my concern. I'll come up with a patch and promise to be careful :-D. |
559468d
to
00585bd
Compare
@matyasselmeci @msalle To see how it could look in the future, please also check my mockup at https://fscheiner.github.io/gct-docs/. The mockup assumes version 7.0 is the latest available version of the GCT and is served from the Interesting BTW that GitHub links those two commit hashes above in the context of gct-docs upstream, although they aren't yet included. ?-/ |
Could you update your mockup to add 00585bd? It looks like the literal string |
Oh, didn't notice this. I just now checked /admin/install/appendix.html and to me it looks like AsciiDoctor cannot or does not expand variables, if a string with a variable is used in another variable. I.e. in the document mentioned above this comes from /admin/breadcrumb_frag.adoc:
...where
and AsciiDoctor seems to use this unexpanded. To be sure I have to check other files which include breadcrumb fragments. That was highly unexpected. UPDATE: Looking at a few other files in the mockup this doesn't seem to happen everywhere, so maybe I am wrong with my assumption above. I'll have to double-check things. Thanks for the pointer. |
An update: After double-checking things, my assumption from #3 (comment) seems to be correct: Variables in document titles are not expanded when using the The reason why it doesn't seem to happen everywhere in the mockup is that some documents use the version number verbatim, e.g. like in https://raw.githubusercontent.com/fscheiner/gct-docs/master/7.0/appendices/commands/index.adoc Sadly this means, that we could not use variables with version numbers in document titles. Quickly scanning through f36ec3e, the majority of related changes unfortunately seems to happen in document titles. But using verbatim version numbers in the document titles and version number variables everywhere else seems to be inappropriate. |
00585bd
to
0367ea4
Compare
@matyasselmeci I'll later come up with a PR for the GCT 6.2 documentation. There I'll follow the original plan to have:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Thanks for all the work!
This includes additional corrections.
Please keep this PR open, because: