Add upstream OpenStack operators documentation to RAG#94
Add upstream OpenStack operators documentation to RAG#94malingatembo wants to merge 1 commit intomainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: malingatembo The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
PR needs rebase. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
umago
left a comment
There was a problem hiding this comment.
Thanks Malinga! It looks very good
Containerfile
Outdated
|
|
||
| # Clean up the OKP content | ||
| RUN rm -rf ./okp-content | ||
| RUN rm -rf ./okp-content || true |
There was a problem hiding this comment.
Is it needed ? -rf should not fail even if the folder does not exist:
[lmartins@fedora tmp]$ rm -rf aaaaaa
[lmartins@fedora tmp]$ echo $?
0
There was a problem hiding this comment.
you are right we do not need that or there at all.
i included it ( and forgot to remove it), during local testing.
I will remove it
Containerfile
Outdated
| # -- Stage 1d: Generate OpenStack Operators plaintext formatted documentation ---------- | ||
| FROM registry.access.redhat.com/ubi9/python-311 as docs-base-operators | ||
|
|
||
| ARG BUILD_OPERATORS_DOCS=true |
There was a problem hiding this comment.
I know it's public document but, I would keep it as false by default because once merged this will mess up existing CI including Konflux.
We could however enable this in the existing GitHub workflow to ensure it's working as expected (assuming it doesn't add a lot of time that will cause a timeout)
There was a problem hiding this comment.
You're right. Addessed it. please check it
Makefile
Outdated
| RHOSO_IGNORE_LIST ?= "" | ||
| RHOSO_REMAP_TITLES ?= {} | ||
| RHOSO_EXCLUDE_TITLES ?= "" | ||
| BUILD_OPERATORS_DOCS ?= true |
There was a problem hiding this comment.
Set it to false :)
| # | ||
|
|
||
| class OpenStackOperatorMetadataProcessor(MetadataProcessor): | ||
| """Metadata processor for OpenStack Kubernetes Operators Documentation""" |
There was a problem hiding this comment.
nit: Kubernets, perhaps OpenShift ?
There was a problem hiding this comment.
OpenShift definately
There was a problem hiding this comment.
I thought k8s, because of the openstack-k8s-operators/
Task: JIRA ticket OSPRH-25960. Include upstream OpenStack Kubernetes operators documentation into the RAG system. Changes: - Add scripts/get_openstack_operators_docs.sh to fetch and convert operators documentation from GitHub (AsciiDoc -> HTML -> plaintext) - Add OpenStackOperatorMetadataProcessor class to generate proper GitHub Pages URLs for operators documentation - Add Stage 1d to Containerfile for operators docs build - Add BUILD_OPERATORS_DOCS, OPERATORS_REPO_URL, and OPERATORS_BRANCH variables to Makefile for configuration - Fixed existing permission error in okp-content cleanup step The operators documentation is fetched from: https://github.com/openstack-k8s-operators/openstack-operator Acceptance criteria met: RAG contains documentation from upstream OpenStack operators (control plane and data plane).
4453395 to
862da5b
Compare
|
@malingatembo: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Task: JIRA ticket OSPRH-25960. Include upstream OpenStack Kubernetes operators documentation into the RAG system.
Changes:
The operators documentation is fetched from:
https://github.com/openstack-k8s-operators/openstack-operator