Giter Club home page Giter Club logo

Comments (5)

dbarrosop avatar dbarrosop commented on August 16, 2024 1

Hi, sorry about that. Thanks for identifying the broken links, the tricky bit here is that the paths should be generated by sphinx rather than be hardcoded (otherwise links might point to the wrong thing in some cases). I dropped a comment in the PR you opened with an example.

from nornir.

mjbear avatar mjbear commented on August 16, 2024

Been a few days so I thought I'd ping this thread. Thank you!
@dbarrosop @ubaumann

from nornir.

mjbear avatar mjbear commented on August 16, 2024

All good.
This makes sense. Thank you for guiding me!

Hopefully these relative paths are correct.

As long as the processors PR goes well then I'll work up changes for the list below.

"Now to create the [nornir](../../ref/api/nornir.rst#nornir) object:"

../api/init_nornir.rst#nornir


"To achieve this `nornir` keeps a set of failed hosts in it's shared [data](../../ref/api/nornir.rst#nornir.core.state.GlobalState) object:"

../api/nornir.rst#nornir.core.state.GlobalState


"If you want to mark some hosts as succeeded and make them back eligible for future tasks you can do it individually per host with the function [recover_host](../../ref/api/nornir.rst#nornir.core.state.GlobalState.recover_host) or reset the list completely with [reset_failed_hosts](../../ref/api/nornir.rst#nornir.core.state.GlobalState.reset_failed_hosts):"

../api/nornir.rst#nornir.core.state.GlobalState.recover_host
../api/nornir.rst#nornir.core.state.GlobalState.reset_failed_hosts

"[open_connection](../ref/api/inventory.rst#nornir.core.inventory.Host.open_connection), [close_connection](../ref/api/inventory.rst#nornir.core.inventory.Host.close_connection), [close_connections](../ref/api/inventory.rst#nornir.core.inventory.Host.close_connections) and [Nornir.close_connections](../ref/api/nornir.rst#nornir.core.Nornir.close_connections). For instance:"

../api/inventory.rst#nornir.core.inventory.Host.open_connection
../api/inventory.rst#nornir.core.inventory.Host.close_connection
../api/inventory.rst#nornir.core.inventory.Host.close_connections
../api/nornir.rst#nornir.core.Nornir.close_connections

"When using the [open_connection](../ref/api/inventory.rst#nornir.core.inventory.Host.open_connection) you can specify any parameters you want. If you don't, or if you let nornir open the connection automatically, nornir will read those parameters from the inventory. You can specify standard attributes at the object level if you want to reuse them across different connections or you can override them for each connection. For example:"

../api/inventory.rst#nornir.core.inventory.Host.open_connection

from nornir.

dbarrosop avatar dbarrosop commented on August 16, 2024

I think this one can be close, can't it? Feel free to reopen otherwise.

from nornir.

mjbear avatar mjbear commented on August 16, 2024

🎯 Once I figure out how to get sphinx working so I can perform a local test then I'll know for sure.
🏆 And from there I can confidently submit PR(s) to fix these links.

All good. This makes sense. Thank you for guiding me!

Hopefully these relative paths are correct.

As long as the processors PR goes well then I'll work up changes for the list below.

"Now to create the [nornir](../../ref/api/nornir.rst#nornir) object:"

../api/init_nornir.rst#nornir

InitNornir docs link doesn't 404, so it is fixed at the current date+time.
Good. 😄

"To achieve this `nornir` keeps a set of failed hosts in it's shared [data](../../ref/api/nornir.rst#nornir.core.state.GlobalState) object:"

../api/nornir.rst#nornir.core.state.GlobalState

Correction: ../../api/nornir/core/state.rst#nornir.core.state.GlobalState

"If you want to mark some hosts as succeeded and make them back eligible for future tasks you can do it individually per host with the function [recover_host](../../ref/api/nornir.rst#nornir.core.state.GlobalState.recover_host) or reset the list completely with [reset_failed_hosts](../../ref/api/nornir.rst#nornir.core.state.GlobalState.reset_failed_hosts):"

../api/nornir.rst#nornir.core.state.GlobalState.recover_host
../api/nornir.rst#nornir.core.state.GlobalState.reset_failed_hosts

Correction:

../../api/nornir/core/state.rst#nornir.core.state.GlobalState.recover_host
../../api/nornir/core/state.rst#nornir.core.state.GlobalState.reset_failed_hosts

"[open_connection](../ref/api/inventory.rst#nornir.core.inventory.Host.open_connection), [close_connection](../ref/api/inventory.rst#nornir.core.inventory.Host.close_connection), [close_connections](../ref/api/inventory.rst#nornir.core.inventory.Host.close_connections) and [Nornir.close_connections](../ref/api/nornir.rst#nornir.core.Nornir.close_connections). For instance:"

../api/inventory.rst#nornir.core.inventory.Host.open_connection
../api/inventory.rst#nornir.core.inventory.Host.close_connection
../api/inventory.rst#nornir.core.inventory.Host.close_connections
../api/nornir.rst#nornir.core.Nornir.close_connections

Correction:

../api/nornir/core/inventory.rst#nornir.core.inventory.Host.open_connection
../api/nornir/core/inventory.rst#nornir.core.inventory.Host.close_connection
../api/nornir/core/inventory.rst#nornir.core.inventory.Host.close_connections

../api/nornir/core/__init__.rst#nornir.core.__init__.Nornir.close_connections

"When using the [open_connection](../ref/api/inventory.rst#nornir.core.inventory.Host.open_connection) you can specify any parameters you want. If you don't, or if you let nornir open the connection automatically, nornir will read those parameters from the inventory. You can specify standard attributes at the object level if you want to reuse them across different connections or you can override them for each connection. For example:"

../api/inventory.rst#nornir.core.inventory.Host.open_connection

Correction: ../api/nornir/core/inventory.rst#nornir.core.inventory.Host.open_connection

from nornir.

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.