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

[Documentation] Minor additions to learning & development guide #761

Merged
merged 1 commit into from
May 17, 2023

Conversation

Olshansk
Copy link
Member

Description

Minor additions to the learning and documentation guide that could help new contributors in onboarding to Pocket.

Issue

NA

Type of change

Please mark the relevant option(s):

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Major breaking change
  • Documentation
  • Other

List of changes

  • Explain all the GitHub labels we have that trigger custom build related actions
  • Point to the GitHub Wiki in the onboarding guide
  • Add links to all of the recent YouTube presentations
  • Link to internal notion docs others may request access to

Testing

  • make develop_test; if any code changes were made
  • make test_e2e on k8s LocalNet; if any code changes were made
  • e2e-devnet-test passes tests on DevNet; if any code was changed
  • Docker Compose LocalNet; if any major functionality was changed or introduced
  • k8s LocalNet; if any infrastructure or configuration changes were made

Required Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
  • I have tested my changes using the available tooling
  • I have updated the corresponding CHANGELOG

If Applicable Checklist

  • I have updated the corresponding README(s); local and/or global
  • I have added tests that prove my fix is effective or that my feature works
  • I have added, or updated, mermaid.js diagrams in the corresponding README(s)
  • I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

@Olshansk Olshansk added the documentation Improvements or additions to documentation label May 17, 2023
@Olshansk Olshansk self-assigned this May 17, 2023
Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

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

Nice one - thanks @Olshansk! 🙌

@Olshansk Olshansk merged commit 6ac9da4 into main May 17, 2023
@Olshansk Olshansk deleted the minor_documentation_improvements branch May 17, 2023 19:37
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 waiting-for-review
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants