Comments (6)
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?
from glossary.
Happy to, are we comfortable maintaining the individual entries as their own files or do we want to combine everything back together?
from glossary.
from glossary.
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
---
from glossary.
from glossary.
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?
from glossary.
Related Issues (20)
- [FR] Update `stateful-apps`
- [FR] Update `stateless-apps`
- [FR] localize Security Chaos Engineering HOT 1
- बेयर मेटल मशीन (Bare Metal Machine) HOT 1
- [zh-cn]Could someone update the dev-zh branch to match the main branch?
- [New term] `Service Catalog` HOT 4
- Glossary feedback button results
- [Portuguese] Enable GH action to check outdated terms
- [Portuguese] Localize search
- [Portuguese] Rename and update the content of tightly-coupled-architectures.md and microservices.md
- [Portuguese] Localize GitOps
- [Portuguese] Localize Pod
- [Portuguese] Localize Runtime
- [Portuguese] Localize Ingress
- [Portuguese] Localize Container Orchestration
- [Portuguese] Localize Role-Based Access Control (RBAC)
- [Portuguese] Update terms to link to Portuguese version
- [infra] Upgrade Docsy, postcss-cli, and autoprefixer
- Enable link checking (paths) across languages HOT 2
- Address 404s and generate Netlify redirect rules from page aliases
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from glossary.