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

docs(markdown): migrate docs from rst to md #422

Merged
merged 8 commits into from
May 21, 2024
Merged

docs(markdown): migrate docs from rst to md #422

merged 8 commits into from
May 21, 2024

Conversation

hetangmodi-crest
Copy link
Contributor

Migrated docs from readthedocs.io to github.io.

@hetangmodi-crest hetangmodi-crest added the documentation Improvements or additions to documentation label May 20, 2024
@hetangmodi-crest hetangmodi-crest self-assigned this May 20, 2024
@hetangmodi-crest hetangmodi-crest marked this pull request as ready for review May 20, 2024 13:47
artemrys
artemrys requested changes May 20, 2024
View reviewed changes
Copy link
Member

@artemrys artemrys left a comment

Choose a reason for hiding this comment

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

Let's clean up README.md file as well - let's have it similar to https://github.com/splunk/pytest-splunk-addon/blob/main/README.md.

If instructions listed there are valid - let's move them in the documentation, if not - let's remove them.

pyproject.toml Outdated Show resolved Hide resolved
@hetangmodi-crest
Copy link
Contributor Author

Let's clean up README.md file as well - let's have it similar to https://github.com/splunk/pytest-splunk-addon/blob/main/README.md.

If instructions listed there are valid - let's move them in the documentation, if not - let's remove them.

The content was related to the design of the framework, which I think isn't relevant to developers using this framework, and hence has been removed.

artemrys
artemrys requested changes May 21, 2024
View reviewed changes
.github/workflows/docs.yml Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
docs/api_reference/components/entity.md Outdated Show resolved Hide resolved
docs/api_reference/index.md Show resolved Hide resolved
@artemrys artemrys merged commit 39ccda1 into main May 21, 2024
8 of 9 checks passed
@artemrys artemrys deleted the chore/move-docs-to-github branch May 21, 2024 14:00
@github-actions github-actions bot locked and limited conversation to collaborators May 21, 2024
@srv-rr-github-token
Copy link
Contributor

🎉 This PR is included in version 4.0.0-beta.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@srv-rr-github-token
Copy link
Contributor

🎉 This PR is included in version 4.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@artemrys artemrys artemrys approved these changes

@mkolasinski-splunk mkolasinski-splunk Awaiting requested review from mkolasinski-splunk

Assignees

@hetangmodi-crest hetangmodi-crest

Labels
documentation Improvements or additions to documentation released on @beta released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hetangmodi-crest @srv-rr-github-token @artemrys