Clarify required versus optional config values #57

New Issue

Closed

opened 2018-02-18 22:09:11 +00:00 by witten · 1 comment

witten commented 2018-02-18 22:09:11 +00:00

Owner

Copy Link

When running generate-borgmatic-config, the command generates a giant config file full of both optional and required configuration values. But only two of the values are actually required, and it's not the best first-time user experience to have to wade through most of the values just to end up deleting them or commenting them out.

So as part of this ticket, improve that first-time experience and make it more obvious which values are required.

Implementation ideas

Idea 1:

Make it more explicit in the generated config file comments:

   # VALUE: source_directories:
   # DEFAULT: /etc
   # [REQUIRED] List of source directories to backup. Globs and tildes are expanded.
   source_directories:
        - /etc
        - /var/www/
        - /var/log/
        - /home/user/data files

(Idea from Zach Coffey.)

Idea 2:

Generate the example config file with optional values commented out, so it's clear that you really just need to focus on the commented-in required values.

Idea 3:

Add a flag to generate-borgmatic-config that generates just the minimal config file with only the required values set.

When running `generate-borgmatic-config`, the command generates a giant config file full of both optional and required configuration values. But only two of the values are actually required, and it's not the best first-time user experience to have to wade through most of the values just to end up deleting them or commenting them out. So as part of this ticket, improve that first-time experience and make it more obvious which values are required. **Implementation ideas** Idea 1: Make it more explicit in the generated config file comments: ``` # VALUE: source_directories: # DEFAULT: /etc # [REQUIRED] List of source directories to backup. Globs and tildes are expanded. source_directories: - /etc - /var/www/ - /var/log/ - /home/user/data files ``` (Idea from Zach Coffey.) Idea 2: Generate the example config file with optional values commented out, so it's clear that you really just need to focus on the commented-in required values. Idea 3: Add a flag to `generate-borgmatic-config` that generates just the minimal config file with only the required values set.

witten referenced this issue from a commit 2018-09-29 22:08:12 +00:00

In generate-borgmatic-config, comment out all optional config (#57).

witten commented 2018-09-29 22:10:21 +00:00

Author

Owner

Copy Link

Implemented idea 2 (optional values render as commented out) in borgmatic 1.2.5.

Implemented idea 2 (optional values render as commented out) in borgmatic 1.2.5.

witten closed this issue 2018-09-29 22:10:21 +00:00

witten referenced this issue from a commit 2023-03-27 22:55:26 +00:00

Labels for repositories (#635).

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

command-hook-steps

2.1.2

2.1.1

2.1.0

2.0.13

2.0.12

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.14

1.8.13

1.8.12

1.8.11

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels

blocked

breaking

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

No Label

Milestone

No items

No Milestone

Assignees

Clear assignees

witten

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#57