Skip to content

Commit

Permalink
adding a puzzle for doing goslate
Browse files Browse the repository at this point in the history
  • Loading branch information
raboley committed Jul 6, 2020
1 parent 534a108 commit 91f21c7
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 301 deletions.
39 changes: 4 additions & 35 deletions source/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,10 @@ Seems like update to code via these diagrams would be a manual process, and be h
npx embedme ./source/index.html.md
```

# GoCli

@todo #41:60mins Create a go cli tool that generates golang documentation via godocs. To make goslate be more useful I think it is important to figure out how to create a cli tool with go that generates documentation so that I can see if it really is a game changer, or if it will just be a different way to do the same thing I already do.

# GoSlate

@todo #41:30mins Create goslate example code
Expand All @@ -323,45 +327,10 @@ go-slate assumes the following source tree:
├── main.go
└── apidoc




@todo #41:30mins document how to run goslate locally

@todo #41:30mins publish goslate docs to github pages

@todo #41:30mins Create github action to publish goslate docs to github pages

@todo #41:15mins update the pre-commit hook to use goslate commands instead of ruby slate.

There are a couple things that run locally to help with development of this repo.

## Up to date scripts with embedme

## Quick, Small iterative issues with PDD

PDD is a style of development that breaks tasks down into small puzzles that can be created, at a high level then get the most basic lazy implementation added, leaving behind smaller todos called puzzles to finish the rest of the implementation.

Puzzles can be added using tags, and running pdd locally will help debug if your puzzle tags are not correct.

```sh
# ../scripts/install-pdd.sh

gem install pdd
# Adding ruby gems to the path if it doesn't exist already
if ! echo "$PATH" | grep --quiet "/usr/local/lib/ruby/gems/2.7.0/bin"; then
echo "No ruby in path"
if ! grep --quiet "/usr/local/lib/ruby/gems/2.7.0/bin" ~/.bash_profile; then
echo "Adding ruby gems to profile"
echo export PATH='"/usr/local/lib/ruby/gems/2.7.0/bin:$PATH"' >> ~/.bash_profile
echo 'pdd has been installed and added to your path. Either restart your terminal or enter the command `source ~/.bash_profile`'
echo 'then you can use `pdd` to see what the output of pdd will be when pushed to the server'
fi
fi
```

will install pdd locally which can then be run in terminal with

```sh
pdd
```
22 changes: 0 additions & 22 deletions src/service/apidoc/includes/_errors.md

This file was deleted.

239 changes: 0 additions & 239 deletions src/service/apidoc/index.html.md

This file was deleted.

5 changes: 0 additions & 5 deletions src/service/main.go

This file was deleted.

7 comments on commit 91f21c7

@0pdd
Copy link
Collaborator

@0pdd 0pdd commented on 91f21c7 Jul 6, 2020

Choose a reason for hiding this comment

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

Puzzle 20-51e8c738 disappeared from source/index.html.md, that's why I closed #41. Please, remember that the puzzle was not necessarily removed in this particular commit. Maybe it happened earlier, but we discovered this fact only now.

@0pdd
Copy link
Collaborator

@0pdd 0pdd commented on 91f21c7 Jul 6, 2020

Choose a reason for hiding this comment

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

Puzzle 41-672a5c88 discovered in source/index.html.md and submitted as #42. Please, remember that the puzzle was not necessarily added in this particular commit. Maybe it was added earlier, but we discovered it only now.

@0pdd
Copy link
Collaborator

@0pdd 0pdd commented on 91f21c7 Jul 6, 2020

Choose a reason for hiding this comment

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

Puzzle 41-6c8e7460 discovered in source/index.html.md and submitted as #43. Please, remember that the puzzle was not necessarily added in this particular commit. Maybe it was added earlier, but we discovered it only now.

@0pdd
Copy link
Collaborator

@0pdd 0pdd commented on 91f21c7 Jul 6, 2020

Choose a reason for hiding this comment

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

Puzzle 41-34c125c5 discovered in source/index.html.md and submitted as #44. Please, remember that the puzzle was not necessarily added in this particular commit. Maybe it was added earlier, but we discovered it only now.

@0pdd
Copy link
Collaborator

@0pdd 0pdd commented on 91f21c7 Jul 6, 2020

Choose a reason for hiding this comment

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

Puzzle 41-998f5ca8 discovered in source/index.html.md and submitted as #45. Please, remember that the puzzle was not necessarily added in this particular commit. Maybe it was added earlier, but we discovered it only now.

@0pdd
Copy link
Collaborator

@0pdd 0pdd commented on 91f21c7 Jul 6, 2020

Choose a reason for hiding this comment

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

Puzzle 41-1d4443c1 discovered in source/index.html.md and submitted as #46. Please, remember that the puzzle was not necessarily added in this particular commit. Maybe it was added earlier, but we discovered it only now.

@0pdd
Copy link
Collaborator

@0pdd 0pdd commented on 91f21c7 Jul 6, 2020

Choose a reason for hiding this comment

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

Puzzle 41-10838dfe discovered in source/index.html.md and submitted as #47. Please, remember that the puzzle was not necessarily added in this particular commit. Maybe it was added earlier, but we discovered it only now.

Please sign in to comment.