Skip to content
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.

Sign up for GitHub

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

Jump to bottom

RHIDP-1542: Document adding templates #219

Merged
merged 1 commit into from
Jun 21, 2024
Merged

RHIDP-1542: Document adding templates #219

merged 1 commit into from
Jun 21, 2024

Conversation

abrennan89
Copy link
Member

@abrennan89 abrennan89 commented May 7, 2024 •
edited
Loading

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented May 7, 2024

PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-219/

@rhdh-bot
Copy link
Collaborator

PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-219/

@rhdh-bot
Copy link
Collaborator

PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-219/

@rhdh-bot
Copy link
Collaborator

PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-219/

@rhdh-bot
Copy link
Collaborator

PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-219/

@abrennan89 abrennan89 changed the title [WIP] RHIDP-1542: Document adding templates RHIDP-1542: Document adding templates May 22, 2024
cmoulliard
cmoulliard suggested changes May 23, 2024
View reviewed changes
modules/templates/proc-adding-templates.adoc Outdated Show resolved Hide resolved
modules/templates/proc-adding-templates.adoc Outdated Show resolved Hide resolved
modules/templates/proc-adding-templates.adoc Outdated Show resolved Hide resolved
@jayfray12
Copy link
Contributor

I have no issue with the content and seems accurate to me however, is the template editor our recommended approach to templates? Shouldn't it be storing them in GitHub/GitLab, etc and using the Catalog processors to ingest them to have a single source of truth?

@rhdh-bot
Copy link
Collaborator

PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-219/

@rhdh-bot
Copy link
Collaborator

PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-219/

@abrennan89 abrennan89 changed the title RHIDP-1542: Document adding templates [WIP] RHIDP-1542: Document adding templates May 29, 2024
@abrennan89
Copy link
Member Author

Reworking per @jayfray12 's suggestion

@abrennan89 abrennan89 changed the title [WIP] RHIDP-1542: Document adding templates RHIDP-1542: Document adding templates May 29, 2024
@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Jun 3, 2024

PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-219/

@cmoulliard
Copy link

PR Preview:

Why are you packaging the documentation which is interesting for the developers or platform engineers part of the admin guide ?

@abrennan89
Copy link
Member Author

PR Preview:

Why are you packaging the documentation which is interesting for the developers or platform engineers part of the admin guide ?

It didn't seem to me like something that would fit within the installation or getting started guides since it requires modifying config files. Where would you prefer it to be included? Also, it would have been good to have included this feedback in #201 instead, because that's where the assembly was actually added. This PR is just expanding on that now existing section.

@cmoulliard
Copy link

It didn't seem to me like something that would fit within the installation or getting started guides since it requires modifying config files. Where would you prefer it to be included?

Ideally that should be part of the guide used by the platform engineer to configure the backstage idp platform, etc
We could move it part of the user guide at the condition that we mention clearly the role of the user part of the guide to avoid to have separate documents

Omar-AlJaljuli
Omar-AlJaljuli approved these changes Jun 18, 2024
View reviewed changes
Copy link
Collaborator

@Omar-AlJaljuli Omar-AlJaljuli left a comment

Choose a reason for hiding this comment

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

LGTM

linfraze
linfraze approved these changes Jun 21, 2024
View reviewed changes
Copy link
Member

@linfraze linfraze left a comment

Choose a reason for hiding this comment

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

One minor change, otherwise lgtm

modules/templates/proc-creating-templates.adoc Show resolved Hide resolved
modules/templates/proc-adding-templates.adoc Outdated Show resolved Hide resolved
@rhdh-bot
Copy link
Collaborator

PR Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-219/

@abrennan89 abrennan89 merged commit a33a93f into redhat-developer:main Jun 21, 2024
2 checks passed
@abrennan89
Copy link
Member Author

/cherrypick 1.1.x

@abrennan89
Copy link
Member Author

/cherrypick 1.2.x

@openshift-cherrypick-robot
Copy link
Contributor

@abrennan89: new pull request created: #314

In response to this:

/cherrypick 1.1.x

Instructions 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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Jun 21, 2024
Merged
@openshift-cherrypick-robot
Copy link
Contributor

@abrennan89: new pull request created: #315

In response to this:

/cherrypick 1.2.x

Instructions 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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Jun 21, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jayfray12 jayfray12 jayfray12 left review comments

@linfraze linfraze linfraze approved these changes

@Omar-AlJaljuli Omar-AlJaljuli Omar-AlJaljuli approved these changes

@cmoulliard cmoulliard Awaiting requested review from cmoulliard

Assignees

@jayfray12 jayfray12

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@abrennan89 @rhdh-bot @jayfray12 @cmoulliard @openshift-cherrypick-robot @linfraze @Omar-AlJaljuli