Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-16744

Scope + Spec documentation

    • Type: Icon: Task Task
    • Resolution: Unresolved
    • Priority: Icon: Minor - P4 Minor - P4
    • None
    • Affects Version/s: None
    • Component/s: Atlas, Compass, Server
    • Labels:
      None

      Initial investigation is here: https://docs.google.com/document/d/1hjnZvHyhg4_7GPAvZ-a1q7xHyZqxSCOyWl4yG0J5G5k/edit?usp=sharing

      The template to use is here: Doc Plan template

      Context:

      Must use shareable content.
      This is the shared repo: https://github.com/10gen/docs-shared However, one major drawback to using this repo is that you can't view content staged when it's added to that repo.
      Not sure if you were looking for other ideas on sharing content besides that repo as well

      Can't use embedded content because of strict naming conventions (Atlas UI cannot use the words Compass in its UI, Compass has its own user base and cannot give up "Compass" as the brand name). Embedded content in docs doesn't allow conditional text for any entries, such as product names. Thus, if we were to embed content from the Compass repo into the Atlas docs repo, then we'd have no way of using a different product name depending on where the users view this content.

      In the scope, outline:

      • Main problems
      • Main goals
      • Solution(s) we chose, why, and how will it look based on existing examples

      In the spec, outline:

      • Team-specific implementation
      • Server/Compass-side work
      • Atlas/DE-side work

            Assignee:
            julia.malkin@mongodb.com Julia Malkin
            Reporter:
            alison.huh@mongodb.com Alison Huh
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              2 weeks, 2 days ago