Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Website section for base guides #229

Closed
2 of 7 tasks
jasonkuhrt opened this issue Jan 6, 2020 · 2 comments
Closed
2 of 7 tasks

Website section for base guides #229

jasonkuhrt opened this issue Jan 6, 2020 · 2 comments
Labels
type/docs Relates to knowledge transfer matter (refs, guides, tuts, examples, ...)

Comments

@jasonkuhrt
Copy link
Member

jasonkuhrt commented Jan 6, 2020

What

  • Content that guides users through particular domains

Why

  • A place to send brand new users to
  • A place to develop concepts around niche domains
  • An at-a-glance index of domains we address or want to address

How

  • We should strive to avoid overlap between guide content and cookbook content

  • VueJS Cookbook directly addresses this schism, learn from their approach, maybe we also want to mention something similar in our content.

  • Content structure idea:

    1. What is this domain?
    2. Why/when is this domain important?
    3. What features does santa have for this domain?
    4. What recipes are there that relate to this domain? (links)
  • Areas to cover:

    introduction

    • what [can it do well]
    • why [does it work this way, and not x,y,z ways]
    • how [do you use it]
    • when [is the target use-case]
    • who [is the target audience]


    other...

    • logging
    • authoring plugins

Related

References

@jasonkuhrt jasonkuhrt added the type/meta Related to something misc around the project e.g. brand, defining principals, ... label Jan 6, 2020
@jasonkuhrt jasonkuhrt changed the title Domain guides Website section for domain-driven guides Jan 6, 2020
@jasonkuhrt jasonkuhrt added type/docs Relates to knowledge transfer matter (refs, guides, tuts, examples, ...) and removed type/meta Related to something misc around the project e.g. brand, defining principals, ... labels Jan 6, 2020
This was referenced Jan 6, 2020
@jasonkuhrt
Copy link
Member Author

Per discussion with @Weakky the following guide sections will be extracted into their own issues. These issues have larger scope because they require more research and maybe api ideation + implementation.

  • databases
  • authentication
  • authorization
  • testing

@jasonkuhrt jasonkuhrt changed the title Website section for domain-driven guides Website section for base guides Jan 7, 2020
@jasonkuhrt
Copy link
Member Author

We have a first version of logging and plugin guides shipped. The ambition/precision listed in this issue is too much for a v1. But the ideas are still valid. Let's revisit in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Relates to knowledge transfer matter (refs, guides, tuts, examples, ...)
Projects
None yet
Development

No branches or pull requests

1 participant