-
Notifications
You must be signed in to change notification settings - Fork 55
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
Add reference generator builds reference from the task graphs #63
Open
kyasbal
wants to merge
23
commits into
GoogleCloudPlatform:main
Choose a base branch
from
kyasbal:generate-document
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
694c5d5
to
2e3f38e
Compare
2e3f38e
to
a52b40a
Compare
9961d49
to
e54fa5a
Compare
- **fix: Make node log parser remap severity correctly**
54fa7bb
to
9adb827
Compare
8dcccb0
to
785860a
Compare
785860a
to
7e2d12e
Compare
da5f8b5
to
120d35d
Compare
585940a
to
87b467b
Compare
* Added make commands * Moved files in refenrence folder * Added callouts saying this reference is under contruction
This comment has been minimized.
This comment has been minimized.
@jyane Can we proceed review for this? At least for the document model part wound be better to have reviews, maybe? |
I'm extremely busy recently due to internal things, @RyuSA could you take a look? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add reference generator builds reference from the task graphs
Preview of the document:
https://github.com/GoogleCloudPlatform/khi/blob/3621de61e8a8a132fd3c6f701f2f0907e3c41017/docs/en/reference/inspection-type.md
Important
Making the whole this reference to a perfect document takes time especially if we care about every sentences of English.
Let's focus our reviews on the way of reference generation and the abstract structure of these reference regarding its template at this moment. And let's improve the content of them with another issue following this PR.
Overview
This PR adds document generator that create/update document markdowns generated from KHI source code.
KHI backend is built top of a DAG task runner system and each tasks have labels. This change make use of these to generate these documents from source code.
This change aims to achieve the following outcomes.
Amendable document auto generator
This PR utilizes the Golang package
template/text
with considering the usage for contributors to extend documents.Generated text from templates consists of multiple section surrounded by:
Users can add texts after
<!-- END GENERATED PART: <ID of the generated section> -->
and the document generator keep the position sticked to the previous generated section.This approach will generate the document with a bit noisy comments, but it enables humans to add contents directly on the document. KHI documents is expected to be hard if that was completely written only with texts, and several features have different points to pay attention. We needed the way to extend the automatically generated reference by human hand especially for adding screenshots, callouts or additional links ...etc.