Opened on 03/13/2014 at 09:47:44 AM
Closed on 10/08/2015 at 12:11:56 PM
#133 closed defect (fixed)
[Document projects consistently] Add a README.md to the sitescripts repository
| Reported by: | fhd | Assignee: | kzar |
|---|---|---|---|
| Priority: | P4 | Milestone: | |
| Module: | Sitescripts | Keywords: | |
| Cc: | trev, sebastian | Blocked By: | |
| Blocking: | #128 | Platform: | Unknown / Cross platform |
| Ready: | yes | Confidential: | no |
| Tester: | Unknown | Verified working: | no |
| Review URL(s): | |||
Description (last modified by fhd)
Background
See #128.
What to change
Since sitescripts consists of several unrelated modules, the top-level README.md should just cover the basics, e.g. multiplexer.py.
It would also make sense to add individual README.mds to the modules under sitescripts/, e.g. as with sitescripts/crawler.
The top-level README.md probably shouldn't list all the modules, pretty likely to get out of sync. Instead it could say that there are several different modules under sitescripts/ and mention that some have their own README.md.
Attachments (0)
Change History (9)
comment:1 Changed on 03/13/2014 at 09:49:29 AM by fhd
- Cc trev added
comment:2 Changed on 03/13/2014 at 09:53:30 AM by fhd
- Blocking 128 added
comment:3 Changed on 03/13/2014 at 09:59:40 AM by fhd
- Description modified (diff)
- Status changed from new to accepted
- Summary changed from Add a README.md to the sitescripts repository to [Document projects consistently] Add a README.md to the sitescripts repository
comment:4 Changed on 03/13/2014 at 10:05:31 AM by trev
Yes, I think individual README.md files for the submodules will be better. The global one only needs to cover the general aspects - e.g. multiplexer and web handlers, Jinja2 templates and custom template filters, config file.
comment:5 Changed on 03/21/2014 at 09:11:02 AM by philll
- Status changed from accepted to new
comment:6 Changed on 02/19/2015 at 01:40:49 PM by sebastian
- Component changed from Infrastructure to Sitescripts
comment:7 Changed on 09/23/2015 at 10:26:59 AM by kzar
- Platform set to Unknown / Cross platform
- Ready unset
- Review URL(s) modified (diff)
- Status changed from new to reviewing
- Tester set to Unknown
comment:8 Changed on 09/23/2015 at 10:27:52 AM by kzar
- Cc sebastian added
- Owner set to kzar
- Ready set
comment:9 Changed on 10/08/2015 at 12:11:56 PM by kzar
- Resolution set to fixed
- Status changed from reviewing to closed
Wladimir, what do you think about the approach above? The alternative would probably be to have everything module-related in the top-level README.md as well, but that could get kinda big.