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

Move Developer Documentation from the Wiki to the CONTRIBUTING.md #2146

Closed
zverulacis opened this issue May 29, 2023 · 3 comments
Closed

Move Developer Documentation from the Wiki to the CONTRIBUTING.md #2146

zverulacis opened this issue May 29, 2023 · 3 comments
Assignees
@zverulacis
Labels
documentation Improvements or additions to documentation initiative: VDK Documentation enhancements story Task for an Epic
Milestone
Documentation (wi...

Comments

@zverulacis
Copy link
Contributor

What is the feature request? What problem does it solve?
It was decided to move the Dev Docs from the Wiki to CONTRIBUTING.md

Suggested solution
Have links in the corresponding sections of CONTRIBUTING.md
Clean up the Dev Guide, remove the unnecessary pages

Dev Guide - link in the CONTRIBUTING.md

  1. Coding Standard
  2. PR best practices
  3. CICD
  4. Dependencies licensing

Additional context
Follow the source ticket if any questions: #1720
@zverulacis zverulacis added enhancement New feature or request story Task for an Epic labels May 29, 2023
@zverulacis zverulacis mentioned this issue May 29, 2023
Closed
@zverulacis zverulacis added documentation Improvements or additions to documentation and removed enhancement New feature or request labels May 29, 2023
@antoniivanov antoniivanov added this to the Documentation milestone Jul 12, 2023
@antoniivanov antoniivanov mentioned this issue Jul 12, 2023
Closed
@antoniivanov
Copy link
Collaborator

antoniivanov commented Jul 12, 2023 •
edited by zverulacis
Loading

Make sure to cover:

@sabadzhiev sabadzhiev mentioned this issue Jul 19, 2023
Closed
@zverulacis zverulacis self-assigned this Sep 8, 2023
@zverulacis
Copy link
Contributor Author

zverulacis commented Sep 12, 2023 •
edited
Loading

CONTRIBUTING.md:

Improve sequence: 

  • 1. Where to find all the docs - link to the wiki
  • 2. Slack channel - to get in touch before you start contributing - we're all there
  • 3. Check the issues and good first issues link
  • 4. PR labels?
  • 5. Improving docs
  • 6. PR approval process
  • 7. Guides on testing - https://github.com/vmware/versatile-data-kit/wiki/Gitlab-CICD
  • 8. list of steps
  • 9. how to start dev environment - link
  • No table of contents
  • Security bugs - confusing sentence -
  • Reverse the order of actions in the sentence about - If you believe you have found a security bug, create a GitHub issue and reach out to us first using any method in the Contact Us section.

zverulacis added a commit that referenced this issue Sep 14, 2023
@zverulacis
First changes to CONTRIBUTING.md based on the feedback #2146
268aac3
@zverulacis
Copy link
Contributor Author

Markdown tips and tricks moved to Documentation Guide.
CONTRIBUTING.md section order changed
Added local IDE and testing

zverulacis added a commit that referenced this issue Sep 19, 2023
@zverulacis @pre-commit-ci
versatile-data-kit: CONTRIBUTING.md feedback / improvements #2146 (#2661
19367cf 
)

This PR is improving the CONTRIBUTING.md file based on feedback
collected through the interviews and the decision to have all the
Development documentation in one place.

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zverulacis zverulacis

Labels
documentation Improvements or additions to documentation initiative: VDK Documentation enhancements story Task for an Epic
Projects
None yet
Milestone
Documentation (wiki) restructuring
Development

No branches or pull requests
3 participants
@antoniivanov @zverulacis @sabadzhiev