-
Notifications
You must be signed in to change notification settings - Fork 534
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 entry format yaml > md #27
Comments
Happy to, are we comfortable maintaining the individual entries as their own files or do we want to combine everything back together? |
imho keep it in one MD for now, just makes it easier
…On Thu, Feb 11, 2021 at 8:53 AM Jason Morgan ***@***.***> wrote:
Happy to, are we comfortable maintaining the individual entries as their
own files or do we want to combine everything back together?
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#27 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAPSIPBVRQH74MQLG4CDDTS6PVQDANCNFSM4XO3DSEA>
.
--
Cheers,
Chris Aniszczyk
http://aniszczyk.org
|
For now, it does. Maybe we are solving for too much @JasonMorgan? Depending on the size the single document may become a lot. I'd suggest breaking the doc into a similar format with a proper table of contents. ---
##title
###category
###status
###definition
--- |
if you're looking for another example of it all in one doc, here:
https://github.com/State-of-the-Edge/glossary/blob/master/edge-glossary.md
It's just easier to deal with :)
…On Thu, Feb 11, 2021 at 9:03 AM Mike Foster ***@***.***> wrote:
imho keep it in one MD for now, just makes it easier
For now, it does. Maybe we are solving for too much @JasonMorgan
<https://github.com/JasonMorgan>?
Depending on the size the single document may become a lot. I'd suggest
breaking the doc into a similar format with a proper table of contents.
---##title###category###status###definition
---
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#27 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAPSIOJJNXRAWRATNEHK5TS6PWTDANCNFSM4XO3DSEA>
.
--
Cheers,
Chris Aniszczyk
http://aniszczyk.org
|
I agree with Michael. The Google doc was hard to navigate. My tendency was to focus on the first entries and I rarely made it to the end. Also, if you want to see the change in preview (which people not familiar with markdown may want to do), there will be a lot of scrolling involved to find the place you want to see. I do agree that a single file is a lot nicer to review as a whole but feel that while we are still working on the individual entries, having them separate will make it easier. How about keeping them separate and merge into one file just before V1 goes live? |
So in the spirit of, "let's do both." I'm happy to send a PR tonight that moves the entries to yaml and expand on, or really change, issue #15 to build a single markdown file with all the combined entries. That'll at a minimum let us try the individual entry format and swap over to a single file with ease. Thoughts? |
Please change entry files from yaml to md
The text was updated successfully, but these errors were encountered: