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

Adding best practices section #836

Merged
merged 4 commits into from
Jul 22, 2024

Conversation

emanuelhaine
Copy link
Collaborator

As I talked to Igor, I am opening this PR so I can start helping on the issus below:

#830
#831

This PR introduces the Best Practics section to the zopen docs
zopen_doc

@IgorTodorovskiIBM
Copy link
Collaborator

@emanuelhaine I see additional changes listed. I think you need to sync your fork/branch with the latest in meta:main

@emanuelhaine
Copy link
Collaborator Author

@IgorTodorovskiIBM ,

I resolved the conflicts. Let me know if it is good now.

docs/_sidebar.md Outdated
@@ -9,6 +9,8 @@
- [Newly Released Packages](/newly_released.md)
- [Package Vulnerabilities](/Vulnerabilities.md)
- [Current Status](/Progress.md)
- [Best Practices](/Guides/section.md)
- zopen
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are you able to create a stub page for these?

@emanuelhaine
Copy link
Collaborator Author

@IgorTodorovskiIBM

It is done. Let me know if you need anything else.

@IgorTodorovskiIBM
Copy link
Collaborator

Thanks, next step would be adding the content but I'm ok with this for now. Perhaps add "(coming soon)" or or similar in the content for now?

@emanuelhaine
Copy link
Collaborator Author

@IgorTodorovskiIBM , I added the "(coming soon)" to new pages that I created

Copy link
Collaborator

@IgorTodorovskiIBM IgorTodorovskiIBM left a comment

Choose a reason for hiding this comment

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

LGTM

@IgorTodorovskiIBM IgorTodorovskiIBM merged commit 56e5613 into zopencommunity:main Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants