Giter Site home page Giter Site logo

Comments (6)

mbohlool avatar mbohlool commented on August 17, 2024

I've tried different things here. The problem is there are lots of link (and link backs) to main README file. If I rename or move it in any way, I need to fix all of the documentation links. It is not terrible to do, but that is what it takes to move the file.

from python.

sebgoa avatar sebgoa commented on August 17, 2024

To help do this (or future change like this in the future), maybe the munge-docs.sh script in k8s main repo can help.

I do think this needs to happen. The current README is super long, and it looks like if we want to update it we need to actually patch the .prefix and then wait for a rebuild (or rebuild entirely in a PR to change a README...).

I would do it :) Bite the bullet now.

from python.

mbohlool avatar mbohlool commented on August 17, 2024

Cool, thanks. Regarding the rebuild, I think we want the generated code always be updated (like other generated codes in k8s). But I agree with you that if there is a better way to do this, we should do it. I will assign the issue to you. Thanks.

from python.

mbohlool avatar mbohlool commented on August 17, 2024

Also, I am not sure how munge-docs.sh works, but now that I think about it, a simple replace /..README.md/README.md/g for all files in doc folder and moving generated README.md file to doc/ folder (after find/replace) should work.

from python.

mbohlool avatar mbohlool commented on August 17, 2024

I've rearranged things in #31 If that is approved by you, then this issue does not apply anymore (no README.prefix in #31 because the generated client is now in a sub directory)

from python.

sebgoa avatar sebgoa commented on August 17, 2024

great, I think it is much better like this.

from python.

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.