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

Refactor: Convert README.rst to README.md #12

Merged
merged 3 commits into from
May 16, 2024
Merged

Conversation

JTaeuber
Copy link
Member

Motivation

Relates to #10.

Changes

  • Changed the README.rst file to a markdown file and changed a few descriptions. I left the pip install pykube-ng since we don`t have a package to install yet.
  • Changed a few values in the pyproject.toml

TODO

  • I've assigned myself to this PR

@JTaeuber JTaeuber added documentation Improvements or additions to documentation housekeeping labels May 15, 2024
@JTaeuber JTaeuber self-assigned this May 15, 2024
@JTaeuber
Copy link
Member Author

There are still references to pykube-ng in the python code. This should be taken care of next.

@Fovty
Copy link
Member

Fovty commented May 15, 2024

In order to keep track, here are the remaining references, right?

  • README.md
  • docs/index.rst
  • docs/users.rst
  • docs/write-an-operator.rst
  • pykube/config.py
  • pykube/http.py
  • pykube/test_config.py
  • pykube/test_http.py

Copy link
Member

@Fovty Fovty left a comment

Choose a reason for hiding this comment

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

LGTM

@JTaeuber
Copy link
Member Author

In order to keep track, here are the remaining references, right?

  • README.md
  • docs/index.rst
  • docs/users.rst
  • docs/write-an-operator.rst
  • pykube/config.py
  • pykube/http.py
  • pykube/test_config.py
  • pykube/test_http.py

Pretty much. Just keep in mind that it's docs/howtos/write-an-operator.rst to avoid confusion.

@JTaeuber JTaeuber merged commit d3f8426 into main May 16, 2024
2 checks passed
@JTaeuber JTaeuber deleted the Refactor/ConvertReadme branch May 16, 2024 06:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation housekeeping
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants