#7870 Clean up .ini files

v1.3.0
closed
sf-2 (994)
General
Heith Seewald
2015-08-20
2015-04-14
No

We should standardize on comment syntax, and add examples/comments for all config values that are possible.

Discussion

  • Dave Brondsema

    Dave Brondsema - 2015-04-15
    • status: in-progress --> review
     
  • Dave Brondsema

    Dave Brondsema - 2015-04-15

    {allura,forgehg}:db/7870

    • run tests, ensure they pass
    • make sure taskd and paster serve work as expected
    • read development.ini and make sure the comments and examples all make sense
     
  • Heith Seewald

    Heith Seewald - 2015-04-16
    • Reviewer: Heith Seewald
     
  • Heith Seewald

    Heith Seewald - 2015-04-20

    Looking really good overall! I have a few minor notes relating to the .ini file:

    1. line 81 forgemail.url <— what is this and is it normally the same as the base_url?
    2. line 114: typo in integratino
    3. line 126: what is a: login_fragment?
    4. lines 322/323 could use an example use case.
    5. line 370: poll_interval = unit of time??
    6. lines: 57, 81, 390-394 The forgemail settings are scattered.
    7. line 407: unit of time?
    8. line 410 — example of a site-wide notification would be nice.
    9. line 426: A quick def of what soft-delete in context of allura
    10. line 485: I’m getting a 404 for the python logging doc with that url

    Some indication of how to use inheritance (like you did in the test.ini) to over-ride local settings would be handy. (this may be better in the docs)

    A huge improvement overall!

     
    • Dave Brondsema

      Dave Brondsema - 2015-04-20

      1. yes it should be the same. forgemail.url is used in outgoing emails. I think we could remove it and just use base_url but I didn't do that at this point.

      4. the oauth.can_import_forum stuff is pretty old and doubtfully even used by anyone. So I don't want to document it more :)

      6. Yes, intentionally. I grouped them with other related settings (outgoing mail, URLs, incoming mail) rather than by name since they seemed to fit better with other settings than with themselves

      Inheritance is explained in the comments the top of the file.

      Everything else addressed with a new commit on db/7870 branch and ready for review.

       

      Last edit: Dave Brondsema 2015-04-20
  • Dave Brondsema

    Dave Brondsema - 2015-04-20
    • status: review --> in-progress
     
  • Dave Brondsema

    Dave Brondsema - 2015-04-20
    • status: in-progress --> review
     
  • Heith Seewald

    Heith Seewald - 2015-04-20
    • status: review --> closed
     
  • Heith Seewald

    Heith Seewald - 2015-04-20

    Ok, looks great!

     
  • Dave Brondsema

    Dave Brondsema - 2015-04-30
    • labels: sf-current, sf-2 --> sf-2
     
  • Igor Bondarenko

    Igor Bondarenko - 2015-06-18
    • Milestone: unreleased --> asf_release_1.3.0
     

Log in to post a comment.