Giter Club home page Giter Club logo

Comments (6)

bryanl avatar bryanl commented on July 20, 2024 2

This idea looks interesting. I'm going to take a couple of days to play around with it and see what comes out.

from ksonnet-lib.

bryanl avatar bryanl commented on July 20, 2024 2

I have a preview of what ksonnet-lib documentation could look like up at http://g.bryan.dev.hepti.center.

from ksonnet-lib.

ukclivecox avatar ukclivecox commented on July 20, 2024 1

Just a ping as I'm also finding it hard to write more complex ksonnet lib files where I need to understand the mixins and other method available.

from ksonnet-lib.

adamdecaf avatar adamdecaf commented on July 20, 2024

@bryanl That looks pretty awesome! It's much nicer to read than the raw jsonnet.

I noticed a couple things.

  1. When you jump to each group the name of that group is cut off. Probably from the "ksonnet API Documentation" header taking up a few pixels ontop of the name.
  2. I might change the (chevron?) screen shot 2018-03-14 at 9 10 29 am icon here. I initially thought I could expand that. ¶ maybe?

http://g.bryan.dev.hepti.center/core/v1/binding/#core.v1.binding.metadata

from ksonnet-lib.

bryanl avatar bryanl commented on July 20, 2024

@adamdecaf this site is not the final layout. The experiment was to see if suitable documentation could be generated from k8s.libsonnet. It helped expose a few gaps which we can hopefully share with the k8s docs team to help improve downstream efforts. Thanks for taking a look and I will work on getting those fixes in there to make it easier to read.

from ksonnet-lib.

Quentin-M avatar Quentin-M commented on July 20, 2024

Hi there!

Is there any progress on this?

Using ksonnet / ksonnet-lib without documentation and with essentially no code completion (the vscode extension is meant to be used for ksonnet as a whole, not ksonnet-lib specifically - and completion freezes often) is hard, and is making several of our developers upset.

from ksonnet-lib.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.