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

Added blog for the content of etcd/contrib/lock/README.md #453

Closed
wants to merge 1 commit into from

Conversation

unnati914
Copy link

Fixes #200

Note: I haven't added the title to the blog, will add it once you review it.

@nate-double-u
Copy link
Contributor

Copy link
Contributor

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

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

Hi @unnati914, thank you for this article!

I've added @chalin and @ptabor as reviewers as I believe they were the original authors of the code and page that this article is replacing.

Some notes about the structure of this article:

  • Since the original file was written as a README in a primarily code based repo, there is an expectation that the accompanying files would be there (and you reference this when you write "The directory contains two programs"), so we'll need to figure out a way to restructure this article in a way that will allow the reader to find those files and refer to them.
  • This restructure may be having that code be a part of the body of the article, or perhaps the original folder should be included and linked to here. Another option may be to zip the files and provide it as a package that the reader can download.
  • The images in the original write up were useful, and appear to be a part of this PR, but don't appear in the rendered page (see the deploy preview), or linked to in the text (though references to figures are made).

I'd suggest generally keeping closer to the formatting and style of the original page (and include a reference for attribution), and adding an introduction explaining what this article is for and how to use the executables I've suggested including above.

Comment on lines +33 to +34
- $ ./build # build etcd
$ goreman start
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd suggest using a code fence rather than a bullet for code/terminal samples like this.

$ ./build      # build etcd
$ goreman start

(a code fence is surrounding a bit of code with "```" on the lines above and below it)

@unnati914
Copy link
Author

sure I will be doing the changes

@nate-double-u
Copy link
Contributor

Closing as this hasn't been updated. Feel free to reopen if you want to continue working on this article.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link to, or write a blog post about, the content of etcd/contrib/lock/README.md
4 participants