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

Change entry format yaml > md #27

Closed
CathPag opened this issue Feb 11, 2021 · 6 comments
Closed

Change entry format yaml > md #27

CathPag opened this issue Feb 11, 2021 · 6 comments
Assignees

Comments

@CathPag
Copy link
Collaborator

CathPag commented Feb 11, 2021

Please change entry files from yaml to md

@JasonMorgan
Copy link
Collaborator

Happy to, are we comfortable maintaining the individual entries as their own files or do we want to combine everything back together?

@caniszczyk
Copy link
Collaborator

caniszczyk commented Feb 11, 2021 via email

@IdealUsrname
Copy link
Contributor

imho keep it in one MD for now, just makes it easier

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
---

@caniszczyk
Copy link
Collaborator

caniszczyk commented Feb 11, 2021 via email

@CathPag
Copy link
Collaborator Author

CathPag commented Feb 11, 2021

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?

@JasonMorgan
Copy link
Collaborator

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?

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

No branches or pull requests

4 participants