-
Notifications
You must be signed in to change notification settings - Fork 16
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
Change docforge manifest API #54
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gardener-robot
added
kind/api-change
API change with impact on API users
needs/second-opinion
Needs second review by someone else
needs/review
Needs review
size/xl
Size of pull request is huge (see gardener-robot robot/bots/size.py)
labels
Oct 18, 2020
gardener-robot-ci-1
added
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
needs/ok-to-test
Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
and removed
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
labels
Oct 18, 2020
gardener-robot-ci-1
added
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
and removed
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
labels
Oct 18, 2020
gardener-robot-ci-2
added
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 18, 2020
gardener-robot-ci-3
removed
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 18, 2020
gardener-robot-ci-2
added
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 19, 2020
gardener-robot-ci-1
removed
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 19, 2020
gardener-robot-ci-2
added
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 19, 2020
gardener-robot-ci-1
removed
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 19, 2020
gardener-robot-ci-3
added
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 19, 2020
gardener-robot-ci-1
removed
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 19, 2020
gardener-robot-ci-3
removed
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 19, 2020
gardener-robot-ci-2
added
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 20, 2020
gardener-robot-ci-1
removed
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 20, 2020
gardener-robot-ci-1
added
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 20, 2020
gardener-robot-ci-2
removed
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 20, 2020
@swilen-iwanow ready for review |
gardener-robot-ci-3
added
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
and removed
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
labels
Oct 21, 2020
gardener-robot-ci-1
added
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
and removed
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
labels
Oct 21, 2020
gardener-robot-ci-2
added
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 21, 2020
gardener-robot-ci-3
removed
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 21, 2020
gardener-robot-ci-1
added
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 21, 2020
gardener-robot-ci-3
removed
the
reviewed/ok-to-test
Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
label
Oct 21, 2020
swilen-iwanow
approved these changes
Oct 22, 2020
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm!
This was referenced Oct 22, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
component/documentation
Gardener Documentation
kind/api-change
API change with impact on API users
needs/ok-to-test
Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD)
needs/second-opinion
Needs second review by someone else
size/xl
Size of pull request is huge (see gardener-robot robot/bots/size.py)
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Changes:
structure
replacesroot
as top level elementstructure
now has a list of node descendants instead of a required single root node.nodeSelector
that resolves intostructure
nodeSelector
andstructure
can co-exist. When resolved the nodes of the node selector are appended to the structure top level nodes. In next iteration the append should change to merge to avoid node duplicates by name.links
replaceslocalityDomain
with new structure and semantic elements:rewrites
for rules governing rewriting document links. Rules are mapped to regular expressions that match links for which they apply. Rewriting targets areversion
,destination
,text
andtitle
of a link.A
nil
rule (~
in yaml) mapped to a regular expression is a shortcut to effectively remove the matched links from the document.Setting the
destination
andtext
property to empty string has the same effect.Setting the
destination
to empty string whentext
is not empty string has the effect removing the link but leaving the text component in the document.downloads
for rules governing the scope of downloaded resources and rename rules for downloads. Rules are mapped to regular expressions that match links for which they apply.Downloads can have
scope
which is the scope of the downloaded resources. The scope is defined by a set of regular expressions for matching resource links to download. They can be optionally mapped to rename rules that define renaming pattern for downloaded resources that match a name pattern expression. Or they can be mapped tonil
(~
in yaml) to specify default rename pattern. The renaming pattern can be an exact string or an expression constructed form three variables provided when a link is matched:.
includedThe default naming pattern is
$uuid$ext
Besides scope-specific renames there can be global ones defined with the
renames
element. It is virtually the same as in the scope renames, but is global ruleset that applies to anything that is subject to download but is not governed by scope-specific rules already.links
settings are inherited. Global top levellinks
apply if more concrete nodeslinks
are not defined. Parent nodelinks
apply if not overridden by node-specificlinks
. A more globallinks
settings can define a subset of the properties to rewrite and nodelinks
can define another. The effectivelinks
for the node is a resolved aggregation of both. For example there might be global rewrite rules for linksversion
and node specific linkdestination
rewrites.nodeSelector
now supportsexcludePaths
anddepth
(starting at 1) filtering options when it is resolved.A few bypass improvements are:
raw
resource type form.Which issue(s) this PR fixes:
Fixes #57
Release note: