Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

#164-First draft of converting adoc templates to markdown #182

Merged
merged 5 commits into from
Feb 11, 2021

Conversation

AstroChoco
Copy link
Contributor

…mplate-logging.md

ALL Pull-Requests require an associated Issue as documented in How to contribute.

Purpose / why

Replace this text - Restate the purpose/justification of this work and include links to the Issue inside of the purpose/why.

What changes were made?

Replace this text - State clearly the direct additions or modifications made in this change-request.

Verification

Replace this text - Document the details that help a reviewer understand what steps or actions should be taken in-order to verify the work is completed and satisfies the initial scope of work.


Checklist

Pull-request reviewer should ensure the following

  • Are issues linked correctly?
  • Is this PR labeled correctly?
  • If template updates: do they align with developers.google.com/style/?
  • Did the PR receive at least one 👍 and no 👎 from core-maintainers?
  • On merging, did you complete the merge using keywords?
  • On merging, did you add any applicable notes to a draft release and link to this PR?

@AstroChoco AstroChoco marked this pull request as draft January 5, 2021 20:58
@AstroChoco AstroChoco changed the title #164-First draft of converting template-logging.adoc to template-logging.md #164-First draft of converting adoc templates to markdown Jan 6, 2021
@mgan59
Copy link
Contributor

mgan59 commented Jan 11, 2021

@AstroChoco I wanted to thank you for your contribution. And just go over a few of the ground rules.
Real quick, proposals for templates should start at the Issues and after a discussion and agreed upon direction the work moves into a PR. The Pull-Request template has a place-holder for that Issue link to be included as well as information regarding the work conducted. It would be helpful to update your Pull-Request description accordingly.

Aside from that, I'll dig in here and give some feedback and thoughts on the work.

Copy link
Contributor

@mgan59 mgan59 left a comment

Choose a reason for hiding this comment

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

I had a chance to review this PR, there are some solid and interesting ideas here. But at this time I don't believe there is a path for this to be mergeable.

BUT, I'd like to keep this PR as part of our knowledge/artifacts as there are great ideas here in a template AND just an overview of how our community maybe authoring their templates.

logging/template-logging.md Outdated Show resolved Hide resolved
logging/template-logging.md Show resolved Hide resolved
logging/template-logging.md Outdated Show resolved Hide resolved
logging/template-logging.md Outdated Show resolved Hide resolved
logging/template-logging.md Show resolved Hide resolved
reference/template-reference.md Outdated Show resolved Hide resolved
@mgan59
Copy link
Contributor

mgan59 commented Jan 11, 2021

@AstroChoco I left feedback here, could you help out and let me know what editor did you write these in? I'm curious to know as it left some artifacts in the markdown and that would help us at the GoodDocsProject understand more about our community of writers

@AstroChoco
Copy link
Contributor Author

@AstroChoco I left feedback here, could you help out and let me know what editor did you write these in? I'm curious to know as it left some artifacts in the markdown and that would help us at the GoodDocsProject understand more about our community of writers

Thanks again for your very constructive comments! I use IntelliJ and a Markdown plugin.

@aidanatwork aidanatwork marked this pull request as ready for review February 11, 2021 17:01
@aidanatwork aidanatwork merged commit cdb3e37 into thegooddocsproject:master Feb 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants