dataplat / docs

The documentation for dbatools module. Issues with command doc and bugs should be reported to dataplat/dbatools.
https://docs.dbatools.io
15 stars 12 forks source link

Sidebar #11

Closed potatoqualitee closed 5 years ago

potatoqualitee commented 6 years ago

I love the sidebar for https://dbachecks.readthedocs.io/en/latest/

where we can add other relevant shortcuts like the various related posts (Cms, Xevents, DA, etc)

can we have something similar? merci

niphlod commented 6 years ago

we can but should we ? It'd be quite hard to inject usefully yet another piece of content in a quite crowded sidebar, dbachecks has not 400ish functions. Maybe it'd be best to either forge an index of sorts (but IMHO for the moment it's better covered by https://dbatools.io/commands/ , till we 'll have proper tagging ) or linking to such posts via each function's help (so it'll be available also for users not jumping on docs.dbatools.io straight away) ?

potatoqualitee commented 6 years ago

What if it were like max 5 URLs? or 3? It is a long sidebar,b ut you take care of it well with tha search filter

niphlod commented 6 years ago

Not an "adding problem", it's just "design wise" how to "highlight" links to external resources(if I got that right they'll be blogposts), and how to "relate" them to one or more doc functions.

Il gio 4 ott 2018, 10:41 Chrissy LeMaire notifications@github.com ha scritto:

What if it were like max 5 URLs? or 3? It is a long sidebar,b ut you take care of it well with tha search filter

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/sqlcollaborative/docs/issues/11#issuecomment-426934547, or mute the thread https://github.com/notifications/unsubscribe-auth/AAHdBzRulXi2-uGqpq3W7-Jfh9Xp9pv-ks5uhcnDgaJpZM4XAtas .

potatoqualitee commented 6 years ago

Global links will be good - so the same 3-5 will show up every time

niphlod commented 6 years ago

then we can make them fixed in the index.html .... what 3-5 links are, specifically ?

niphlod commented 6 years ago

/cc @potatoqualitee : can you list the 3-5 links so I can create a "mockup" for validation ?

niphlod commented 5 years ago

heads up @potatoqualitee

potatoqualitee commented 5 years ago

oh sorry mmmmmm lets see

dbatools.io/offline dbatools.io/start dbatools.io/secure

and maybe dbatools.io/clone dbatools.io/cms dbatools.io/snapshots