Comments (4)
I don't mind us having per-VMOD pages, as long as we have a plan for how to maintain them.
My idea was to format the vmod.vcc file, like we do for docs, and use that (we already have the url of that in the JSON format) would that be enough or would you want more info ?
Should we ask VMOD maintainers to include a RST file in their repos and put its URL in the JSON ?
For github I guess we could default to the README if there is one ?
from homepage.
That would make sense, I don't imagine it would be asking too much of VMOD maintainers to have a file in the repo so it can be grabbed for here.
from homepage.
Ok, so I haven't tried pulling the READMEs off github but I've got a branch that generates a page for each VMOD master...glennslaven:vmodpages
I'm not 100% sure on using the READMEs, I think their formats are a bit too variable to include in a page. I like the idea of asking for a rst file to include though, that could work. vmod_description.rst
or something like that. If we kept the name standardised then they wouldn't have to put a link to it, the build script could just go look for repourl + "vmod_description.rst"
.
from homepage.
I agree that the READMEs were not a feasible way.
As I said in the pull request, instead I have made it possible to declare a documentation URL in the JSON which appear in a new column in the table, and I have redirected all the old urls to the table.
from homepage.
Related Issues (13)
- Updates/changes in the site as RSS feeds HOT 1
- VarnishCon AMS 2016 HOT 2
- Next major release HOT 1
- Turn the Extras list into different sections HOT 2
- Decide the future of the mailing lists HOT 4
- one canonical url, 301 the others HOT 3
- wget without --header="Accept-encoding: gzip" returns unzipped tarball HOT 1
- Clean up links about old versions, and clarify "the latest release" HOT 2
- Analytics on the site HOT 7
- Broken links need to be fixed. 404s make our users unhappy. HOT 16
- Extras inconsistency HOT 1
- Missing of IP2Proxy VMOD in the listing.
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 homepage.