docs: dependent resources and other improvements #1064
Conversation
| } | ||
|
|
||
| // omitted code | ||
| implements Reconciler<WebPage>, ErrorStatusHandler<WebPage>, EventSourceInitializer<WebPage> { |
There was a problem hiding this comment.
Isn't there a way to include code directly from the repo instead of having to copy it here?
There was a problem hiding this comment.
Good, point will check!
There was a problem hiding this comment.
https://emgithub.com/
can do the trick, the problem is that it is not very well formatted (while it is on that page directly), it is not in the resulting jekyll page.
Also I would use permalinks, since any reformat / change can mess this up if we want to use it. Since we reference the code snippet based on line numbers.
There was a problem hiding this comment.
So it messes up the formatting, I was not able to fix it for now. What do you think should we use this? @metacosm
There was a problem hiding this comment.
That I already added, see "See the full source code sample here" parts.
There was a problem hiding this comment.
Ahh you mean only that, I think that is very hard to read. At least I personally don't like if it's done that way in the docs.
There was a problem hiding this comment.
I'd prefer if we could embed the code but if we can't do it nicely, then copying the code in the doc is more problematic because then it needs to be maintained and risk being outdated, causing user confusion.
There was a problem hiding this comment.
I would also prefer that, it's just not formatted now :(
And was not able to fix it for now.
I would merge this as it is, to be consistent with other parts of the docs, and we can migrate / take a look on the embedding & formatting isses seratelly, pretty sure that can be fixed somehow.
There was a problem hiding this comment.
And will migrate all the docs to that in a separate PR.
Co-authored-by: Chris Laprun <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
No description provided.