Skip to content
This repository has been archived by the owner on Apr 22, 2021. It is now read-only.

Improving the workflow for new contributors #67

Open
sedmonds opened this issue Jul 30, 2020 · 0 comments
Open

Improving the workflow for new contributors #67

sedmonds opened this issue Jul 30, 2020 · 0 comments

Comments

@sedmonds
Copy link
Contributor

I reviewed the current documentation and suggest the creation of a better 'Getting Started' and 'Using Autopilot' chapters in proposed Autopilot manual.

Chapter 1: Getting Started
What is Web archiving?
Why Autopilot?
Installing Autopilot?
Autopilot Basics
About Web Traffic
Status Page: Pre-made Behaviors

Chapter 2: Using Autopilot
Creating Your First Behavior [For beginner the dev/user]
Testing Your First Behavior
Fixing a Broken Behavior
Checking Behavior Status
...

Chapter 3: Hacking Autopilot [For advanced devs: current documentation]
Contributing to Autopilot
Tools of the Trade
Creating a Behavior
Testing a Behavior (Debugging)
Behaviors
Build System
CLI
Overview on behaviors
Provided cli commands
Behavior standard library reference
...

Chapter 4: Behind Autopilot
Maintainers
Contact Support
Discussion Forum
Who Uses Autopilot?
...

Reference: API
CBehaviorRunner
CMutationStream
FinitRunnableBehavior
FcreateState
FstateWithMsgNoWait
FstateWithMsgWait
FstateWithMsgWaitFromAwaitable
FstateWithMsgWaitFromFn
FbrowserHistoryGoBack
FbrowserLocation
FlocationContains
FlocationEquals
FwaitForHistoryManipToChangeLocation
Fclick
FclickAndWaitFor
FclickAndWaitForHistoryChange
FclickInContext
FclickInContextWithDelay
FclickWithDelay
FscrollAllIntoViewAndClick
FscrollAllIntoViewAndClickWithDelay
FchainQs
FchildElementIterator
FchildNodeIterator
...

FAQ
Is Autopilot open source?
What does Autopilot cost?
What platforms does Autopilot run on?
How can I contribute to Autopilot?
Glossary of Terms

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant