Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize top-level config keys #170

Closed
dcastro opened this issue Sep 25, 2022 · 0 comments · Fixed by #175
Closed

Reorganize top-level config keys #170

dcastro opened this issue Sep 25, 2022 · 0 comments · Fixed by #175
Assignees
Milestone

Comments

@dcastro
Copy link
Member

dcastro commented Sep 25, 2022

Clarification and motivation

At the moment, the config yaml is organized in 3 top-level keys: traversal, verification and scanners.

traversal:
# Glob patterns describing files which we pretend do not exist
# (so they are neither analyzed nor can be referenced).
ignored:
# Git files
- .git/**/*
# Stack files
- .stack-work/**/*
# Verification parameters.
verification:
# On 'anchor not found' error, how much similar anchors should be displayed as
# hint. Number should be between 0 and 1, larger value means stricter filter.
anchorSimilarityThreshold: 0.5
# When checking external references, how long to wait on request before
# declaring "Response timeout".
externalRefCheckTimeout: 10s
# Glob patterns describing the files, references in which should not be analyzed.
notScanned:
- :PLACEHOLDER:notScanned:
# Glob patterns describing the files which do not physically exist in the
# repository but should be treated as existing nevertheless.
virtualFiles:
- :PLACEHOLDER:virtualFiles:
# POSIX extended regular expressions that match external references
# that have to be ignored (not verified).
ignoreRefs:
# Ignore localhost links by default
- ^(https?|ftps?)://(localhost|127\.0\.0\.1).*
# Skip links which return 403 or 401 code.
ignoreAuthFailures: true
# When a verification result is a "429 Too Many Requests" response
# and it does not contain a "Retry-After" header,
# wait this amount of time before attempting to verify the link again.
defaultRetryAfter: 30s
# How many attempts to retry an external link after getting
# a "429 Too Many Requests" response.
maxRetries: 3
# Parameters of scanners for various file types.
scanners:
markdown:
# Flavor of markdown, e.g. GitHub-flavor.
#
# This affects which anchors are generated for headers.
flavor: :PLACEHOLDER:flavor:

However, as was discussed in this thread, the distinction between the "traversal" and the "verification" stages is not relevant to the user. This is entirely an internal concern.

A better way of organizing these options would be:

  1. exclusions: ignored, notScanned, ...
  2. networking: externalRefCheckTimeout, ignoreAuthFailures, defaultRetryAfter, ...
  3. scanners

Acceptance criteria

The yaml config options are organized under exclusions, networking and scanners.

@dcastro dcastro added this to the 0.3 milestone Sep 25, 2022
@Sereja313 Sereja313 self-assigned this Sep 27, 2022
Sereja313 added a commit that referenced this issue Sep 27, 2022
Problem: At the moment, the config yaml is organized in 3 top-level
keys: `traversal`, `verification` and `scanners`. However, the distinction
between the "traversal" and the "verification" stages is not relevant
to the user. This is entirely an internal concern.

Solution: Reorganize yaml config options under `exclusions`, `networking`
and `scanners`.
Sereja313 added a commit that referenced this issue Sep 27, 2022
Problem: At the moment, the config yaml is organized in 3 top-level
keys: `traversal`, `verification` and `scanners`. However, the distinction
between the "traversal" and the "verification" stages is not relevant
to the user. This is entirely an internal concern.

Solution: Reorganize yaml config options under `exclusions`, `networking`
and `scanners`.
@Sereja313 Sereja313 linked a pull request Sep 27, 2022 that will close this issue
12 tasks
Sereja313 added a commit that referenced this issue Sep 28, 2022
Problem: At the moment, the config yaml is organized in 3 top-level
keys: `traversal`, `verification` and `scanners`. However, the distinction
between the "traversal" and the "verification" stages is not relevant
to the user. This is entirely an internal concern.

Solution: Reorganize yaml config options under `exclusions`, `networking`
and `scanners`.
Sereja313 added a commit that referenced this issue Sep 28, 2022
Problem: At the moment, the config yaml is organized in 3 top-level
keys: `traversal`, `verification` and `scanners`. However, the distinction
between the "traversal" and the "verification" stages is not relevant
to the user. This is entirely an internal concern.

Solution: Reorganize yaml config options under `exclusions`, `networking`
and `scanners`.
Sereja313 added a commit that referenced this issue Oct 25, 2022
Problem: At the moment, the config yaml is organized in 3 top-level
keys: `traversal`, `verification` and `scanners`. However, the distinction
between the "traversal" and the "verification" stages is not relevant
to the user. This is entirely an internal concern.

Solution: Reorganize yaml config options under `exclusions`, `networking`
and `scanners`.
Sereja313 added a commit that referenced this issue Oct 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants