Skip to content

docs: Update org profile README, short desc and usefull links#2

Open
jpmewenemesse wants to merge 3 commits intoOKDP:mainfrom
jpmewenemesse:feat/update-org-profile-readme
Open

docs: Update org profile README, short desc and usefull links#2
jpmewenemesse wants to merge 3 commits intoOKDP:mainfrom
jpmewenemesse:feat/update-org-profile-readme

Conversation

@jpmewenemesse
Copy link
Copy Markdown
Collaborator

Updated org profile README to replace Github default template provided at repo creation time

@jpmewenemesse jpmewenemesse self-assigned this Apr 24, 2026
@jpmewenemesse jpmewenemesse linked an issue Apr 27, 2026 that may be closed by this pull request
13 tasks
@jpmewenemesse jpmewenemesse requested a review from rpignolet April 27, 2026 13:33
@jpmewenemesse jpmewenemesse force-pushed the feat/update-org-profile-readme branch from 027f94f to a5ed4fb Compare April 27, 2026 13:44
@rpignolet
Copy link
Copy Markdown

I do not understand the use case for this PR, can you explain ? When we create a repo we want an empty repository, why populate it with a README ?

@jpmewenemesse
Copy link
Copy Markdown
Collaborator Author

@rpignolet It is not repos README. This is shown in the organization landing page (https://github.com/OKDP).
Feel free to read more here

@rpignolet
Copy link
Copy Markdown

rpignolet commented Apr 28, 2026

So your first comment on this PR is wrong or I do not understand

Updated org profile README to replace Github default template provided at repo creation time

@jpmewenemesse
Copy link
Copy Markdown
Collaborator Author

jpmewenemesse commented Apr 28, 2026

@rpignolet When you create a brand new special .github repo, Github suggest from the UI to automatically create the profile/README if not available. If you agree to create it, Github automatically generate that profile/README with just some comments message in it.
So my comment was saying that, I am replacing the default auto generated profile/README at .github repo creation time

@jpmewenemesse jpmewenemesse requested a review from lioneloh May 4, 2026 15:33
Comment thread profile/README.md
Comment thread profile/README.md
Deploy only what you need: Apache Spark, Hive Metastore, Trino, Superset, Airflow, JupyterHub, each as a standalone Helm chart or as a complete, OIDC-secured stack.

- **Try it** → [okdp-sandbox](https://github.com/OKDP/okdp-sandbox): deploy the full stack in minutes
- **Install** → [helm-handbook](https://github.com/OKDP/helm-handbook): Helm chart install guides and values
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

the repository is private (and not yet ready). We should remove the line and populate it later when public and ready. We should also consider if a a documentation website link would be better This documentation website would describe how to install helm charts

Comment thread profile/README.md
- **Try it** → [okdp-sandbox](https://github.com/OKDP/okdp-sandbox): deploy the full stack in minutes
- **Install** → [helm-handbook](https://github.com/OKDP/helm-handbook): Helm chart install guides and values
- **Learn more** → [OKDP/OKDP](https://github.com/OKDP/OKDP): component inventory and governance
- **Contribute** → see our [Contributing Guide](https://github.com/OKDP/.github/blob/main/CONTRIBUTING.md)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

CONTRIBUTING.md is not available.

As the PR for CONTRIBUTING.md is ongoing and in parallel we could leave as is but for better review process, next time we should have the CONTRIBUTING.md PR contain all the changes related to it.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

You are right. Currently the CONTRIBUTING.md is in this PR

Co-authored-by: Lionel Herbet <lionel.herbet@orange.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[governance] Create OKDP/.github org-level community health files

3 participants