Skip to content
This repository has been archived by the owner on Aug 19, 2024. It is now read-only.

Initial Docs #64

Merged
merged 56 commits into from
Jan 4, 2024
Merged

Initial Docs #64

merged 56 commits into from
Jan 4, 2024

Conversation

gazarenkov
Copy link
Member

@gazarenkov gazarenkov commented Dec 12, 2023

Description

Initial repository docs, WIP

Which issue(s) does this PR fix or relate to

related to #28
related to #83
related to #80

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
config/manager/kustomization.yaml Outdated Show resolved Hide resolved
docs/developer.md Outdated Show resolved Hide resolved
@gazarenkov gazarenkov marked this pull request as draft December 13, 2023 15:02
gazarenkov and others added 3 commits December 13, 2023 17:19
Co-authored-by: Armel Soro <armel@rm3l.org>
Co-authored-by: Armel Soro <armel@rm3l.org>
Co-authored-by: Armel Soro <armel@rm3l.org>
@rm3l
Copy link
Member

rm3l commented Dec 18, 2023

After a quick sync with the docs team, let's continue moving fwd on this PR, so that they can have something they can rely upon as soon as possible.

TODO: POSTGRES_HOST = <name-of the service> , POSTGRES_PORT = <port>[5432] can be delivered to the Backstage
Deployment out of Postgres Secret? Indeed, it is not really a secret.
## The Goal
The Goal of [Backstage](https://backstage.io) Operator project is creating Kubernetes Operator for configuring, installing and synchronizing Backstage instance on Kubernetes/OpenShift.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we're targetting k8s, only openshift. IIRC the helmchart is for k8s (and openshift too) but the operator is ONLY for openshift. @jasperchui @christophe-f am I correct here?

Copy link
Member Author

@gazarenkov gazarenkov Dec 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nickboldt the codebase is working and tested on both K8s AND Openshift.
This is the message for GitHub repository README.
We probably need to slightly change this message and we definitely need to add more information about openshift/operatorhub as soon as we have it, but technically it is the truth and I doubt it will be much differ from the helm chart I guess (support of openshift == support of k8s + Route for this operator)

So, I'd definitely welcome improving the message from the marketing standpoint if it is the goal here but technically the current message it is relevant :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll let @christophe-f weigh in from the PM side. I'm OK with technically correct docs, but we don't want to imply support that we won't actually do.

README.md Outdated Show resolved Hide resolved
gazarenkov and others added 5 commits December 20, 2023 10:42
Co-authored-by: Nick Boldt <nboldt@redhat.com>
Co-authored-by: Armel Soro <armel@rm3l.org>
Co-authored-by: Armel Soro <armel@rm3l.org>
Co-authored-by: Armel Soro <armel@rm3l.org>
Co-authored-by: Armel Soro <armel@rm3l.org>
@gazarenkov gazarenkov changed the title [DRAFT] Initial Docs Initial Docs Dec 20, 2023
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docker/bundle.Dockerfile Outdated Show resolved Hide resolved
Copy link
Member

@nickboldt nickboldt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should really remove the arches that are not being built/supported -- in the CSV, see lines 167-169.

                        - arm64
                        - ppc64le
                        - s390x

docs/admin.md Outdated Show resolved Hide resolved
docker/bundle.Dockerfile Outdated Show resolved Hide resolved
Co-authored-by: Nick Boldt <nboldt@redhat.com>
Co-authored-by: Nick Boldt <nboldt@redhat.com>
Co-authored-by: Nick Boldt <nboldt@redhat.com>
Co-authored-by: Nick Boldt <nboldt@redhat.com>
Co-authored-by: Nick Boldt <nboldt@redhat.com>
Co-authored-by: Nick Boldt <nboldt@redhat.com>
@gazarenkov
Copy link
Member Author

we should really remove the arches that are not being built/supported -- in the CSV, see lines 167-169.

                        - arm64
                        - ppc64le
                        - s390x

+1

@gazarenkov gazarenkov merged commit 7f1df4f into janus-idp:main Jan 4, 2024
5 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants