Opened 5 years ago

Closed 4 years ago

#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):

https://codereview.adblockplus.org/29328521/

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.

Change History (9)

comment:1 Changed 5 years ago by fhd

  • Cc trev added

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.

comment:2 Changed 5 years ago by fhd

  • Blocking 128 added

comment:3 Changed 5 years ago 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 5 years ago 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 5 years ago by philll

  • Status changed from accepted to new

comment:6 Changed 4 years ago by sebastian

  • Component changed from Infrastructure to Sitescripts

comment:7 Changed 4 years ago 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 4 years ago by kzar

  • Cc sebastian added
  • Owner set to kzar
  • Ready set

comment:9 Changed 4 years ago by kzar

  • Resolution set to fixed
  • Status changed from reviewing to closed
Note: See TracTickets for help on using tickets.