New documentation for chapter 1 #70
Conversation
chapter1.md
Outdated
| Both [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) must be installed to run Autopilot. | ||
|
|
||
| To install Autopilot, use Terminal to clone the Webrecorder repository: | ||
| 1. `git clone ` |
There was a problem hiding this comment.
We might want to highlight also building from source; not sure which is best. Is the docker impl. kept up to date? @ikreymer
This isn't blocking for now though
There was a problem hiding this comment.
Yes, Docker implementation should be, it is how its deployed in production for Conifer, will double check that its working. Yeah, probably both should be mentioned.
chapter1.md
Outdated
|
|
||
| The Autopilot instance can be accessed in the browser at `http://localhost:8089`. | ||
|
|
||
| ^^ EXPLAIN BETTER, also do I need to explain remote browsers/what Docker is? |
There was a problem hiding this comment.
Maybe a sentence or two, and/or a link for docker but not much required imo
|
Just wanted to say this is looking like a great start to more friendly docs :) |
chapter1.md
Outdated
|
|
||
| The following options are available to use with the behaviors command: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
as this is intended as a quick getting started guide I think that we don't need to put this output of help in here
chapter1.md
Outdated
| The following options are available to use with the API command: | ||
|
|
||
| ``` | ||
| $ ./bin/cli api --help |
…not need this), and set up the pre-made behaviors sectin
…s knowledge, still testing the premade behaviors for chapter 1
…2 so that it's easier to follow for a beginner, and some notes in chapter3 for how it should be written
…ting started using the CLI"
… behavior" o Please enter the commit message for your changes. Lines starting
chapter2.md
Outdated
| @@ -0,0 +1,299 @@ | |||
| # Chapter 2: Creating your first behavior | |||
There was a problem hiding this comment.
these files need to be in manual or some other sub directory
There was a problem hiding this comment.
seems like they're duplicated
|
When looking at the section for "Installing Autopilot" and view the ordered list, I'm wondering why we wouldn't remove #3 and #4. Or indicate in some way, steps 3/4 are not needed for basic setup. ie. Placing these two docker-related steps in an advanced area. Let me know if a PR or better clarification would be helpful. Thanks! |
| @@ -0,0 +1,15 @@ | |||
| #Bug Report Template | |||
There was a problem hiding this comment.
this could be in .github/ISSUE_TEMPLATE/bug-report.md with the following at the top of the file
---
name: Bug Report
about: Report an issue or problem
title: ""
labels: bug
assignees: ''
---
No description provided.