Git Product home page Git Product logo

Comments (5)

lukas-vlcek avatar lukas-vlcek commented on June 18, 2024 1

@msfroh There are two parts.

  1. Missing search_pipelines parameter in the docs. When added it is relevant to 2.x as well, so it should be beckported if I understand correctly (I am also not sure what is the versioning story for docs).
  2. Taking search_pipelines out of the default set of "metrics" (which will apply to some other "metrics" added in the future too, like node_analyzers). This will not go to 2.x.

That is why I talk about two PRs ... but again, I am not sure about the versioning strategy for docs at the moment.

from documentation-website.

hdhalter avatar hdhalter commented on June 18, 2024 1

Hi @lukas-vlcek , @msfroh , agreed, It sounds like two different PRs. We are updating the documentation for only the latest version of 2.x, which currently is 2.12. So, we can update the search_pipelines parameter there. can also create PRs for future (e.g., 3.0) documentation and just label it as 3.0 so we know not to merge it.

from documentation-website.

msfroh avatar msfroh commented on June 18, 2024

Yup.... this was a miss on my part when the search pipelines feature was added.

It was added to NodesInfo more so that nodes could coordinate amongst themselves (refusing to create a search pipeline unless all data nodes have the relevant processors installed). I forgot that NodesInfo is also user-visible.

from documentation-website.

lukas-vlcek avatar lukas-vlcek commented on June 18, 2024

The thing is that with the change being introduced here I also wanted to provide documentation update. Are you fine with me adding the missing search_pipeline parameter to NodesInfo doc and marking it as not included in the default set of "metrics"?
(Although I think this should be two separated documentation PRs: one to add the search_pipelines parameter, second making it non default)

from documentation-website.

msfroh avatar msfroh commented on June 18, 2024

That change isn't going to be backported to 2.x because it's a breaking change, right?

In that case, for now, the doc change should just be to add the parameter I think.

Doc team, how are we planning to handle eventual 3.0 docs? I've kind of assumed that we're treating that as a "worry about it tomorrow problem" (but I like procrastinating).

from documentation-website.

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.