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.

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

feat: Doc updates, Issue and PR templates are added #1970

Merged
merged 12 commits into from
Apr 14, 2024

Conversation

vara-bonthu
Copy link
Contributor

@vara-bonthu vara-bonthu commented Apr 14, 2024

What does this PR do

Changes Included:

README Update: The main README.md now features the Kubeflow header and includes a new link to our updated Slack channel, facilitating better community engagement.

PR Template Addition: Added a new pull request template to the .github folder to streamline future contributions.

Workflow Update: Updated references to the container registry in our GitHub workflows to use ghcr.io, ensuring consistency with our current infrastructure.

Contributing Guidelines Revision: Removed the requirement for Google CLA from our contributing guidelines to simplify the contribution process.

Issue Templates Creation: Created new issue templates for Bugs, Features, and Questions to organize and prioritize incoming issues more efficiently.

@vara-bonthu
Copy link
Contributor Author

vara-bonthu commented Apr 14, 2024

One of the workflow is failed due to the bug introduced by recent PRs. Ignore this and this will be addressed in the next PR.

@AndrewChubatiuk Are you aware of this workflow?

image

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yuchaoran2011 yuchaoran2011 left a comment

Choose a reason for hiding this comment

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

/lgtm

@AndrewChubatiuk
Copy link
Contributor

@vara-bonthu fixed it in my PR. this PR has only changes in README.md, but has no changes in README.md template. workflow validates if there are changes in README.md after make helm-docs execution

@ChenYi015
Copy link
Contributor

@vara-bonthu Just run make helm-docs and commit the changes. I have updated README.go.tmpl in #1958. If there are any changes to the chart, like chart version, the command make helm-docs should be run to update the README.md file.

@vara-bonthu
Copy link
Contributor Author

@ChenYi015 It might be beneficial to include the pre-commit instructions in the contributing.md file to assist contributors.

@ChenYi015
Copy link
Contributor

@ChenYi015 It might be beneficial to include the pre-commit instructions in the contributing.md file to assist contributors.

Agree, I will do it.

vara-bonthu and others added 12 commits April 13, 2024 23:18
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
…elines

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
…low guidelines"

This reverts commit b892f5c.

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Andrew Chubatiuk <andrew.chubatiuk@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Copy link
Contributor

@yuchaoran2011 yuchaoran2011 left a comment

Choose a reason for hiding this comment

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

/lgtm

@google-oss-prow google-oss-prow bot added the lgtm label Apr 14, 2024
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vara-bonthu, yuchaoran2011

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [vara-bonthu,yuchaoran2011]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit 69e9841 into kubeflow:master Apr 14, 2024
7 checks passed
@vara-bonthu vara-bonthu deleted the feat/docs branch April 14, 2024 06:25
peter-mcclonski pushed a commit to TechnologyBrewery/spark-on-k8s-operator that referenced this pull request Apr 16, 2024
* Issue templates are added to the repo

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* removed Google CLA requirement

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Updated ghcr.io registry references in the workflow

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Added Pull request template

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Updated Main README.md with Kubeflow header and new Slack channel link

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Removed the License header and it will be replaced with Kubeflow guidelines

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Revert "Removed the License header and it will be replaced with Kubeflow guidelines"

This reverts commit b892f5c.

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Readme line revert for gcp docs

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* pre-commit run -a updates

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* fixed the helm lint issue by upgrading the Helm chart version

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* fixed docker image tag and updated chart docs (kubeflow#1969)

Signed-off-by: Andrew Chubatiuk <andrew.chubatiuk@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* rebase from master

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

---------

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Andrew Chubatiuk <andrew.chubatiuk@gmail.com>
Co-authored-by: Andrii Chubatiuk <andrew.chubatiuk@gmail.com>
Signed-off-by: Peter McClonski <mcclonski_peter@bah.com>
sigmarkarl pushed a commit to spotinst/spark-on-k8s-operator that referenced this pull request Aug 7, 2024
* Issue templates are added to the repo

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* removed Google CLA requirement

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Updated ghcr.io registry references in the workflow

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Added Pull request template

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Updated Main README.md with Kubeflow header and new Slack channel link

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Removed the License header and it will be replaced with Kubeflow guidelines

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Revert "Removed the License header and it will be replaced with Kubeflow guidelines"

This reverts commit b892f5c.

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Readme line revert for gcp docs

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* pre-commit run -a updates

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* fixed the helm lint issue by upgrading the Helm chart version

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* fixed docker image tag and updated chart docs (kubeflow#1969)

Signed-off-by: Andrew Chubatiuk <andrew.chubatiuk@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* rebase from master

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

---------

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Andrew Chubatiuk <andrew.chubatiuk@gmail.com>
Co-authored-by: Andrii Chubatiuk <andrew.chubatiuk@gmail.com>
jbhalodia-slack pushed a commit to jbhalodia-slack/spark-operator that referenced this pull request Oct 4, 2024
* Issue templates are added to the repo

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* removed Google CLA requirement

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Updated ghcr.io registry references in the workflow

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Added Pull request template

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Updated Main README.md with Kubeflow header and new Slack channel link

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Removed the License header and it will be replaced with Kubeflow guidelines

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Revert "Removed the License header and it will be replaced with Kubeflow guidelines"

This reverts commit b892f5c.

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* Readme line revert for gcp docs

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* pre-commit run -a updates

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* fixed the helm lint issue by upgrading the Helm chart version

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* fixed docker image tag and updated chart docs (kubeflow#1969)

Signed-off-by: Andrew Chubatiuk <andrew.chubatiuk@gmail.com>
Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

* rebase from master

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>

---------

Signed-off-by: Vara Bonthu <vara.bonthu@gmail.com>
Signed-off-by: Andrew Chubatiuk <andrew.chubatiuk@gmail.com>
Co-authored-by: Andrii Chubatiuk <andrew.chubatiuk@gmail.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.

4 participants