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

docs: Create Developer-CLI-Tutorial.md #500

Merged
merged 22 commits into from
Nov 22, 2021
Merged

docs: Create Developer-CLI-Tutorial.md #500

merged 22 commits into from
Nov 22, 2021

Conversation

BlackPanthar
Copy link
Contributor

@BlackPanthar BlackPanthar commented Nov 10, 2021

Description

Developer CLI tutorial for newbies.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@aljo242 aljo242 changed the title Create Developer-CLI-Tutorial.md docs: Create Developer-CLI-Tutorial.md Nov 10, 2021
Copy link
Contributor

@aljo242 aljo242 left a comment

Choose a reason for hiding this comment

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

There are some unclear steps, or things that can be clarified before merging. See comments.

docs/Developer-CLI-Tutorial.md Outdated Show resolved Hide resolved
docs/Developer-CLI-Tutorial.md Outdated Show resolved Hide resolved
docs/Developer-CLI-Tutorial.md Outdated Show resolved Hide resolved
docs/Developer-CLI-Tutorial.md Outdated Show resolved Hide resolved
Edited to address review by Alex
docs/Developer-CLI-Tutorial.md Outdated Show resolved Hide resolved
@barriebyron
Copy link
Contributor

hi Pylons friends! @BlackPanthar and @aljo242
I made it about halfway through the CLI tutorial and ran out of time today.
I created you a Pylons content guidance worksheet.

See if you can follow the examples and structure that I put in place and make similar changes throughout.

Let's sync next week to answer all of the many questions you might have.

It's great to see this progress, let's keep up the great momentum.

Yours in service, Barrie

@aljo242
Copy link
Contributor

aljo242 commented Nov 12, 2021

Thanks so much for your help so far @barriebyron !

:)

@BlackPanthar
Copy link
Contributor Author

@barriebyron I've made changes based on your Pylons content guidance worksheet. Kindly have another look. Again, thanks!

Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

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

@BlackPanthar please make the changes we discussed, in regard to capitalization (title case) and any other changes you would like to see.

This doc is much improved! congratulations.

I'm OOO until Monday after Thanksgiving (a big US eating holiday!)
I'll be available for more help after Nov 29.

for now, keep up good work!

@BlackPanthar
Copy link
Contributor Author

@giunatale @aljo242 your changes are addressed, your status is not updated.

@aljo242
Copy link
Contributor

aljo242 commented Nov 22, 2021

@giunatale @aljo242 your changes are addressed, your status is not updated.

It looks like Barrie asked for some more changes while approving. And there has not been a commit since then. So, I'm waiting on that.

@BlackPanthar
Copy link
Contributor Author

BlackPanthar commented Nov 22, 2021

@aljo242 The changes have been addressed except in cases where there's an all-caps word in the heading. For example CLI tutorial instead of Cli Tutorial to fulfil the title case. I left the former. All other headings satisfy title case.

@aljo242 aljo242 merged commit ae670cd into main Nov 22, 2021
@aljo242 aljo242 deleted the Developer-CLI-Tutorial branch November 23, 2021 14:13
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.

None yet

4 participants