guide: extract remote add/modify (advanced) config details to UG

[skshetry]

UPDATE: Jump to #1859 (comment)

UPDATE 2: Some related tickets that could potentially be included in this refactor:

• ref: better prioritize and highlight common remote options #1699
• ref: clarify about obfuscated remote file structure (same as cache) #1762

---

It'd be great if we could share the link to that container directly (that on opening would expand the container and scroll that touser's viewport).

eg: The following section on command-reference/run#description.

[jorgeorpinel]

Would be nice to have. Probably not very hard to implement either but I'm not convinced there's a huge need. We indeed already have a bit of a problem of linking to anchors too much — it's best to avoid that as headers tend to change which causes semi-broken links which are very hard to detect.

[shcheklein]

My take on this- if it happens with a certain section then it probably means that the section should not be collapsible- rather regular section, like the one @skshetry mentioned. In a lot of cases we use collapsible sections as a substitute for the whole page (e.g. remotes).

[jorgeorpinel]

Good point. So should we change this to reviewing the existing <details> sections? E.g. are you saying we should use regular H3 sections in remote add and modify @shcheklein ?

[shcheklein]

So should we change this to reviewing the existing

sections?

let's do this as we go, care by case

E.g. are you saying we should use regular H3 sections in remote add and modify @shcheklein ?

yes, if there is a feeling that we want to share a link, or that information is important enough, not auxiliary

[jorgeorpinel]

do this as we go

Got it. So, close this issue (as not actionable)

that information is important enough, not auxiliary

In the case of remote add/modify examples the usage of the details sections is not to include auxiliary info but simply to make the docs more compact. They would be really really long otherwise. The other approach would be to break up the doc into several pages but it's not clear to me how (without new engine features).

[shcheklein]

Got it. So, close this issue (as not actionable)

why? we can make specifically this section H3?

The other approach would be to break up the doc into several pages but it's not clear to me how (without new engine features).

just break like we do for Google Drive (to some extent)? Just create separate pages and link them from those small collapsibles ?

[jorgeorpinel]

can make specifically this section H3

I think that was just a generic example. Or are we trying to actually link to Avoiding unexpected behavior in https://dvc.org/doc/command-reference/run#description from somewhere @skshetry ?

Just create separate pages

Unlisted pages? (not in nav) Yeah that could work, it's just not something we do much currently.

[shcheklein]

Unlisted pages? (not in nav) Yeah that could work, it's just not something we do much currently.

no, I mean regular page. We should not be doing unlisted pages (why?). Similar to GDrive.

[jorgeorpinel]

break like we do for Google Drive
I mean regular page

OK so a single guide specifically for remote add/modify configuration... OK, that should work, repurposing issue!

[shcheklein]

OK, that should work, repurposing issue!

I think, let's wait on @skshetry .. it might be he wanted to share this specific link

[jorgeorpinel]

A good first attempt (specific to Azure): #2634

[daavoo]

A good first attempt (specific to Azure): #2634

Another user has created something that could be part of a Setup a Microsoft Azure DVC Remote guide:

iterative/dvc#2200 (comment)

[shcheklein]

I think we have prematurely renamed this issue. This was not about remotes, it was about run?

[jorgeorpinel]

Hmm yeah I probably didn't notice your message in #1859 (comment) and then @skshetry never followed up so this issue was repurposed. I believe he meant this as a general feature though, either for that run ref example or other places... I guess I should reopen both that issue and the one about moving remote ref details to the UG ⏳

[jorgeorpinel]

See #2865
and #2866