Update the README in the github repo and provide a skeleton for more documentation

RESOLVED FIXED

Status

Hello (Loop)
Client
P1
normal
Rank:
18
RESOLVED FIXED
2 years ago
2 years ago

People

(Reporter: standard8, Assigned: standard8)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

User Story

- README at top level
-- Anyone interested in Loop, contributing, qa, testing etc
- docs/Contributing
-- General docs for contributing process
- docs/Developing
-- General docs on how to develop & available tools
- docs/Testing
-- Docs on test harnesses etc

Attachments

(2 attachments)

(Assignee)

Description

2 years ago
Now we've moved to the repo, we need to update our README file and start adding more documents on our testing and contributing etc
(Assignee)

Updated

2 years ago
User Story: (updated)
(Assignee)

Comment 1

2 years ago
WIP at https://github.com/Standard8/loop/tree/bug-1232111-readme
(Assignee)

Updated

2 years ago
Rank: 11
Priority: -- → P1
(Assignee)

Comment 2

2 years ago
Created attachment 8698442 [details] [review]
Link to Github pull-request: https://github.com/mozilla/loop/pull/12

This isn't everything I want to do here, but its a start. I really want to do a basic development doc, but haven't had time to yet. So lets just get the readme updated and the contributing doc landed.
Attachment #8698442 - Flags: review?(mdeboer)
Attachment #8698442 - Flags: review?(edilee)
Attachment #8698442 - Flags: review?(dmose)

Comment 3

2 years ago
Comment on attachment 8698442 [details] [review]
Link to Github pull-request: https://github.com/mozilla/loop/pull/12

Looks like a fine start for the docs. Some minor nits/issues noted in pull request.
Attachment #8698442 - Flags: review?(mdeboer)
Attachment #8698442 - Flags: review?(edilee)
Attachment #8698442 - Flags: review?(dmose)
Attachment #8698442 - Flags: review+
(Assignee)

Comment 4

2 years ago
https://github.com/mozilla/loop/commit/665134f50beebd3e2e6a7ca0fc4f74decd6c5095

Leaving open to do skeleton docs on the other items.
(Assignee)

Comment 5

2 years ago
We've already landed some of this, I think the next bits are slightly lower prio.
Rank: 11 → 18

Comment 6

2 years ago
Created attachment 8706603 [details] [review]
[loop] Standard8:bug-1232111-readme > mozilla:master
(Assignee)

Comment 7

2 years ago
Comment on attachment 8706603 [details] [review]
[loop] Standard8:bug-1232111-readme > mozilla:master

This is intended to be a simple document outlining various parts of the build, run & test system and how to use them.

There's probably sections missing, pointers to background info etc, but we can add those later - this is just getting the basics described first.
Attachment #8706603 - Flags: review?(edilee)
Attachment #8706603 - Flags: review?(dmose)
Attachment #8706603 - Flags: review?(dcritchley)
Attachment #8706603 - Flags: review?(dcritchley) → review+
(Assignee)

Updated

2 years ago
Attachment #8706603 - Flags: review?(edilee)
Attachment #8706603 - Flags: review?(dmose)
(Assignee)

Comment 8

2 years ago
https://github.com/Standard8/loop/commit/f6c39a6a2c53e09d59d9b33c9f46653e905db3ec
Status: NEW → RESOLVED
Iteration: --- → 46.3 - Jan 25
Last Resolved: 2 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.