Comments (3)
Thanks for starting this thread! Any (CNCF) projects that you feel do this well? I feel like most projects I've seen like Prometheus have them separate.
from opencost.
The docs had been here in opencost/opencost, but we moved them over to opencost/opencost-website because it was easier to manage formatting and templating for inclusion in opencost.io. I think it's unlikely we'll move the docs back, unless we did some sort of git submodule (ick) on the opencost-website side.
The advantage would be if we had some sort of docs per release auto-generation, but that feels like a lot of work. If there are examples of this available I'd consider it, but maintaining docs is already a challenge.
from opencost.
@dwbrown2 You have me very surprised. I just checked a few of them (I didn't do that before I opened the issue), and all I checked had them separate.
This surprises me. In my experience, putting docs and code as close together as possible always worked better. But maybe the scale of things here is an issue. I could imagine a lot of merge conflicts when editing the same docs files.
@mattray I would just put the docs under docs.opencost.io and wouldn't care too much about the layout, to be honest. But that is my personal preference. That way you could link out from the opencost.io, and have the docs be a simple mkdocs release to a different folder. So both can work in parallel. No git-ickery needed :)
from opencost.
Related Issues (20)
- Opencost :: Cloud cost console blank HOT 3
- Cloud Costs need to be persisted for querying/export HOT 1
- OpenCost aggregation not working for custom labels HOT 4
- Error with query parameter to victoria metrics HOT 1
- __unallocated__ metrics/ resources for Deployments HOT 8
- How do I configure the sharednamespaces correctly HOT 1
- Public Cloud Cost Integration - Improve Documentation HOT 3
- Azure multiple subscription connection HOT 1
- Opencost fails to download Price Sheet from Azure HOT 4
- Scaleway Pricing Model JSON HOT 6
- Permission denied error in cloudcost integration HOT 2
- High memory usage. HOT 10
- Multi Cluster observability HOT 1
- node_cpu_hourly_cost value not reconciling with actual Azure Price Rates HOT 3
- Create whitelist for all labels not used for controller or service selection to improve query performance and memory usage. HOT 5
- Modify k8s API caches and watchers to only store relevant projections of pod
- Customise midnight run schedule HOT 2
- Documentation : limitation on container_cpu_allocation ? HOT 1
- Cannot set readOnlyRootFilesystem for ui container HOT 2
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 opencost.