Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-99328

Policies under docs/ should be more discoverable

    • Type: Icon: Task Task
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • Server Programmability

      Recently we've been introducing some new policies, such as the noexcept rules (SERVER-70148) and the C++ style guide (SERVER-90340). These go under docs/ and they are mixed in with architecture guides and learning resources. In many cases, this makes a lot of sense - for example, noexcept seems to fit in with exception architecture. However, if someone is looking to learn what policies they must follow when writing code for the server, it's hard for them to find that.

      There should be a way for people to find a list of policies at a glance. For example, maybe we could create an index of all policies with links to headings within documents where policies are defined.

            Assignee:
            Unassigned Unassigned
            Reporter:
            ryan.berryhill@mongodb.com Ryan Berryhill
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: