Giter VIP home page Giter VIP logo

Comments (4)

erezrokah avatar erezrokah commented on June 1, 2024 1

Hi @dsmith111 and thank you for opening the issue. Looks like we're missing some docs around this.

We replace the VERSION_ placeholder just before publishing so the doc file we upload actually has the correct version embedded, see

find: "(?i)version_${{ needs.prepare.outputs.plugin_kind }}_${{ needs.prepare.outputs.plugin_name }}"

I believe the RegEx here just needs to be updated to accept "-" dash characters as it already appears to accept "_" delimiters.

This RegEx is not used in https://hub.cloudquery.io/. It' deprecated and was used when we had only a single version (the latest one) of the plugins docs published under https://docs.cloudquery.io/docs

from cloudquery.

erezrokah avatar erezrokah commented on June 1, 2024 1

My suggestion is to update the docs manually/automatically before publish each version

from cloudquery.

dsmith111 avatar dsmith111 commented on June 1, 2024 1

Thanks for the info @erezrokah. Yeah, docs would add a bit more clarity. I saw the official plugins used a "VERSION" place-holder, and when I used that placeholder myself, with the tool name, it was automatically replaced after running cloudquery publish with the latest plugin version, so I assumed this was just an undocumented feature. Similar to using _configuration.md with the ":configuration" flag in a different document to insert it.

from cloudquery.

erezrokah avatar erezrokah commented on June 1, 2024

undocumented feature. Similar to using _configuration.md with the ":configuration" flag in a different document to insert it.

Yeah, we used these placeholders during the migration from the old Website where we had only a single version each plugin's docs. They allowed us to have both docs versions up during the transition, and we'll be phasing out the placeholders now that all plugins are in the Hub

from cloudquery.

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.