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

Remove unnecessary use of apiargs files

    XMLWordPrintableJSON

Details

    Description

      Description

      Currently use various apiargs include files for methods and commands.

      Move away from apiargs

      Scope of changes

      • Write script to add the apiargs table content in the method/command argument tables.
      • Remove the apiargs files
      • Verify that the content change is sane
        • Build and deploy before changes
        • Rebuild and deploy after changes – shouldn't really see file content changes (barring some spacing or blank line changes and such)

      Future project will determine how/when to single source.

      Impact to Other Docs/Teams

      DPO team will not need to worry about apiargs for next gen (at least for server manual)

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

      Attachments

        Activity

          People

            kay.kim@mongodb.com Kay Kim (Inactive)
            kay.kim@mongodb.com Kay Kim (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              4 years, 19 weeks, 6 days ago