This repository was archived by the owner on Sep 30, 2024. It is now read-only.
Update campaign docs to include examples and YAML reference#13638
Merged
Conversation
This adds back the examples we previously had, adopted to the new campaign specs. Where and how the examples are referenced follows what was proposed in sourcegraph/sourcegraph#10921 but temporarily removed.
Contributor
Author
|
Alright, I also played "JSON schema to Markdown" converter and created the campaign spec YAML reference that was proposed in #10921. Yes, there's duplication between this handwritten markdown file and the |
Codecov Report
@@ Coverage Diff @@
## main #13638 +/- ##
==========================================
+ Coverage 44.34% 53.67% +9.32%
==========================================
Files 747 1347 +600
Lines 21959 79184 +57225
Branches 6748 5302 -1446
==========================================
+ Hits 9737 42499 +32762
- Misses 12168 33125 +20957
- Partials 54 3560 +3506
|
eseliger
approved these changes
Sep 4, 2020
eseliger
left a comment
Member
There was a problem hiding this comment.
Very nice! That reads very well, easy to understand :)
kghopson
approved these changes
Sep 4, 2020
kghopson
left a comment
Contributor
There was a problem hiding this comment.
LGTM. I was able to follow along, so that's always a good indicator
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
This adds back the examples we previously had, adopted to the new campaign specs.
Where and how the examples are referenced follows what was proposed in https://github.com/sourcegraph/sourcegraph/pull/10921 but temporarily removed.
Edit:
It also does a bunch of other things, like making the wording clearer, etc.