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.

Sign up for GitHub

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

Jump to bottom

*: run 'marker' in CI #7864

Merged
merged 3 commits into from
May 4, 2017
Merged

*: run 'marker' in CI #7864

merged 3 commits into from
May 4, 2017

Conversation

gyuho
Copy link
Contributor

@gyuho gyuho commented May 3, 2017 •
edited

Fix #7123.

@gyuho gyuho changed the title *: run marker, fix broken doc links *: fix broken links in markdown May 3, 2017
@gyuho gyuho removed the WIP label May 3, 2017
@gyuho gyuho requested a review from heyitsanthony May 3, 2017 17:23
@gyuho gyuho added this to the v3.2.0 milestone May 3, 2017
xiang90
xiang90 reviewed May 3, 2017
View reviewed changes
tools/etcd-dump-db/README.md Outdated
@@ -38,7 +38,7 @@ meta
```


#### hash [data dir or db file path]
#### hash `[data dir or db file path]`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this does not look good.

/cc @crawford can you patch marker to ignore [] checking in the title?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's possible to have links in the header though. I would suggest making the heading the command verb and then listing the usage below (/cc @joshix).

Maybe something like:

hash

Computes the hash of db file.

Usage:
  etcd-dump-db hash [data dir or db file path] [flags]

Flags:
  -h, --help   help for hash

$ etcd-dump-db hash agent01/agent.etcd
db path: agent01/agent.etcd/member/snap/db
Hash: 3700260467


$ etcd-dump-db hash agent02/agent.etcd

db path: agent02/agent.etcd/member/snap/db
Hash: 3700260467


$ etcd-dump-db hash agent03/agent.etcd

db path: agent03/agent.etcd/member/snap/db
Hash: 3700260467

@gyuho gyuho requested a review from crawford May 3, 2017 19:50
@gyuho gyuho mentioned this pull request May 3, 2017
Merged
@gyuho gyuho added the WIP label May 3, 2017
@gyuho gyuho changed the title *: fix broken links in markdown *: run 'marker', fix broken links in markdown May 3, 2017
@gyuho
Copy link
Contributor Author

gyuho commented May 4, 2017 •
edited

@xiang90 @heyitsanthony I made it run only on Documentation directory for now, and move [DEPRECATED] to another line without [. PTAL.

@gyuho gyuho removed the WIP label May 4, 2017
@gyuho gyuho changed the title *: run 'marker', fix broken links in markdown *: run 'marker' in CI May 4, 2017
@xiang90
Copy link
Contributor

xiang90 commented May 4, 2017

lgtm

crawford
crawford reviewed May 4, 2017
View reviewed changes
test Outdated
# TODO: check other markdown files when marker handles headers with '[]'
if which marker >/dev/null; then
echo "Checking marker to find broken links..."
markerResult=`marker --root ./Documentation 2>&1 || true`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might want to use --skip-http. Otherwise, marker will do a bunch of HEAD and GET requests to check remote resources. This is pretty slow and might spuriously fail.

gyuho added 3 commits May 4, 2017 08:26
@gyuho
scripts,travis: install 'marker' for CI tests
e9a6347 
Signed-off-by: Gyu-Ho Lee <gyuhox@gmail.com>
@gyuho
test: run 'marker' to find broken links
c2959c9 
Signed-off-by: Gyu-Ho Lee <gyuhox@gmail.com>
@gyuho
Documentation: remove '[]' from '[DEPRECATED]'
282c6fd 
To make 'marker' pass the tests

Signed-off-by: Gyu-Ho Lee <gyuhox@gmail.com>
@heyitsanthony
Copy link
Contributor

lgtm thanks

@codecov-io
Copy link

Codecov Report

Merging #7864 into master will decrease coverage by 0.18%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #7864      +/-   ##
==========================================
- Coverage   75.76%   75.58%   -0.19%     
==========================================
  Files         332      332              
  Lines       26203    26203              
==========================================
- Hits        19853    19805      -48     
- Misses       4923     4968      +45     
- Partials     1427     1430       +3
Impacted Files Coverage Δ
proxy/grpcproxy/register.go 83.33% <0%> (-11.12%) ⬇️
pkg/adt/interval_tree.go 77.74% <0%> (-6.41%) ⬇️
clientv3/namespace/watch.go 87.87% <0%> (-6.07%) ⬇️
proxy/grpcproxy/watcher.go 89.58% <0%> (-4.17%) ⬇️
rafthttp/msgappv2_codec.go 71.3% <0%> (-3.48%) ⬇️
proxy/grpcproxy/watch.go 90.97% <0%> (-3.48%) ⬇️
etcdserver/api/v3election/election.go 64.7% <0%> (-2.95%) ⬇️
pkg/transport/listener_tls.go 73.91% <0%> (-2.18%) ⬇️
rafthttp/peer.go 90.07% <0%> (-1.53%) ⬇️
etcdmain/etcd.go 44.2% <0%> (-1.29%) ⬇️
... and 10 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7f05e22...282c6fd. Read the comment docs.

@gyuho gyuho merged commit 505bf8c into etcd-io:master May 4, 2017
@gyuho gyuho deleted the doc-link-fixes branch May 4, 2017 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crawford crawford crawford left review comments

@xiang90 xiang90 xiang90 left review comments

@heyitsanthony heyitsanthony heyitsanthony approved these changes

Assignees
No one assigned
Labels