Fix errors in api reference doc #262
Merged
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
Signed-off-by: frherrer <frherrer@redhat.com>
fjglira
force-pushed
the
issue-251-fix
branch
2 times, most recently
from
1adc58f to
fe48471
Compare
dgn
reviewed
Aug 12, 2024
Makefile.core.mk
Outdated
| @@ -385,6 +385,15 @@ gen-api-docs: ## Generate API documentation. | |||
| --renderer=markdown \ | |||
| --output-path=$(OUTPUT_DOCS_PATH) \ | |||
| --output-mode=group | |||
| @echo "The following replaces are applied to the generated markdown files as workaround" | |||
There was a problem hiding this comment.
I would just add this and the following two lines as comments in the Makefile. It doesn't have to be shown every time we generate the docs IMO
Signed-off-by: frherrer <frherrer@redhat.com>
Updated :) |
dgn
pushed a commit
to dgn/sail-operator
that referenced
this pull request
Aug 13, 2024
* Fix errors in api reference doc Signed-off-by: frherrer <frherrer@redhat.com> * Replace eco information by comments in the make gen-api-docs target Signed-off-by: frherrer <frherrer@redhat.com> --------- Signed-off-by: frherrer <frherrer@redhat.com> Signed-off-by: Daniel Grimm <dgrimm@redhat.com>
openshift-service-mesh-bot
referenced
this pull request
in openshift-service-mesh-bot/sail-operator
Aug 13, 2024
* upstream/main: Ensure `make gen-check` works when go mod cache is empty (openshift-service-mesh#270) Introduce RemoteIstio (openshift-service-mesh#202) api_transformer: use `go env` to detect mod cache dir (openshift-service-mesh#269) Add field values.experimental to API (openshift-service-mesh#264) Fix errors in tables for api reference documentation (openshift-service-mesh#263) Generate CNIGlobalConfig from GlobalConfig automatically (openshift-service-mesh#260) Fix errors in api reference doc (openshift-service-mesh#262) Rename `addTags` to `addComments` in API transformer (openshift-service-mesh#259) Add relatedImages to ClusterServiceVersion (openshift-service-mesh#243) Generate API from versions defined in go.mod (openshift-service-mesh#258) Fix issues identified during API review (openshift-service-mesh#254) # Conflicts: # bundle/manifests/sailoperator.clusterserviceversion.yaml
istio-testing
pushed a commit
that referenced
this pull request
Aug 13, 2024
* Fix errors in api reference doc Signed-off-by: frherrer <frherrer@redhat.com> * Replace eco information by comments in the make gen-api-docs target Signed-off-by: frherrer <frherrer@redhat.com> --------- Signed-off-by: frherrer <frherrer@redhat.com> Signed-off-by: Daniel Grimm <dgrimm@redhat.com>
openshift-service-mesh-bot
referenced
this pull request
in openshift-service-mesh-bot/sail-operator
Aug 13, 2024
* upstream/main: Add `RemoteIstio` to API concepts in docs (openshift-service-mesh#272) Ensure `make gen-check` works when go mod cache is empty (openshift-service-mesh#270) Introduce RemoteIstio (openshift-service-mesh#202) api_transformer: use `go env` to detect mod cache dir (openshift-service-mesh#269) Add field values.experimental to API (openshift-service-mesh#264) Fix errors in tables for api reference documentation (openshift-service-mesh#263) Generate CNIGlobalConfig from GlobalConfig automatically (openshift-service-mesh#260) Fix errors in api reference doc (openshift-service-mesh#262) Rename `addTags` to `addComments` in API transformer (openshift-service-mesh#259) Add relatedImages to ClusterServiceVersion (openshift-service-mesh#243) Generate API from versions defined in go.mod (openshift-service-mesh#258) Fix issues identified during API review (openshift-service-mesh#254) # Conflicts: # bundle/manifests/sailoperator.clusterserviceversion.yaml
asmigala
pushed a commit
to asmigala/sail-operator
that referenced
this pull request
Mar 2, 2025
…t/master-release-3.0-merge_upstream_release-1.0-a8adebe8 Automator: merge upstream changes to openshift-service-mesh/sail-operator@release-3.0
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.
Fixes #251
As discussed with @luksa the changes are in the make target
make gen-api-docsbecause we can't for now properly handle tabs replacement and new line deletion in theast nodesbecausego fmtreplaces the spaces by tabs by default and add those newlines. I'll check this behavior to see if it is a bug or if there is a way to avoid it