blog: shtab completion

[casperdcl]

Article about iterative/shtab.

PR opened primarily to discuss content; not necessarily to merge here (may decide to post elsewhere).

Intention: target general Python devs who may not know about DVC but know the pain of CLI development, thus raising awareness.

preview: https://dvc-landing-shtab-compl-j408nx.herokuapp.com/blog/shtab-completion

[casperdcl]

Taking inspiration from xkcd; is it worth the time?

shtab would be on the second row, far left (maybe even off grid when considering the number of potential users). It's worth spending days/weeks to sort out but now takes only a minute to fix.

[shcheklein]

@casperdcl you have to specify an image (picture) in the frontmatter for this to be deployed

[casperdcl]

@shcheklein not sure about blog formatting - is this documented somewhere?

• picture: is this required? Who creates it? A new picture has to be authored every post?
• author: is this a github username?
• commentsUrl: https://discuss.dvc.org/t/some-title/374
  • what does the /t/ mean?
  • what does the /374 mean? Who generates this number?
• tags: is there a list to choose from?

[casperdcl]

Hmm https://dvc.org/doc/user-guide/contributing/blog states that the frontmatter picture is optional.

I also don't have access permissions for the heroku deployment so can't check the build errors.

[shcheklein]

@casperdcl this is a bug to my mind, it should be optional (cc @rogermparent - do we need a ticket for this?) ... could you for not use any image from the previous blogs, just to deploy this :)

[casperdcl]

idk since I can't see the logs what I can/can't do to fix this. E.g. are external links allowed? I can commit things blind until it works (probably) :D

[rogermparent]

I can take this on soon, in all likelihood optional frontmatter images should be a quick fix. It's probably big enough to warrant an issue, but I'll check it asap whether there is one or not.

[casperdcl]

Also do the pictures have to be hosted locally? E.g. I just filled in an xkcd permalink which presumably is reliable enough that we don't have to mirror? The deployment looks like it isn't rendering the external image.

[jorgeorpinel]

We forgot to review these. Probably too many @shcheklein @casperdcl ? I'd only keep Release and maybe shtab because no other tag has any posts. Would maybe add CLI if it's added retroactively to a few others.

[casperdcl]

Is there a way to see all current tags?

[jorgeorpinel]

I was wondering the same thing: #1657

[shcheklein]

@jorgeorpinel @casperdcl //cc @elleobrien - tags serve two goals - navigation (and we want to keep them sane for this), and SEO (keywords in meta - I haven't checked this, but I hope it still works or we need to fix this). For SEO we want to include things that people will use to search - "Python CLI autocomplete", etc. Thus we need to have a good balance. No need to optimize tags just for the sake of trying to keep them to the minimum.

[jorgeorpinel]

OK in that case all tags here seem relevant, for SEO that is. Though I should say, I think most search engines pretty much ignore suggested meta keywords and extract them from the content instead. But if the meta keywords match the content, then it may be a nice extra.