[DOCS-12889] Remove unnecessary use of apiargs files Created: 12/Jul/19  Updated: 30/Oct/23  Resolved: 26/Sep/19

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Improvement Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Kay Kim (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 4 years, 19 weeks, 6 days ago
Epic Link: DOCSP-1769

 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.)



 Comments   
Comment by Githook User [ 26/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: fix
Branch: v2.4
https://github.com/mongodb/docs/commit/24abb7b7c40488096b34442a8d6b9c0fb554fb3b

Comment by Githook User [ 26/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove last apiargs files
Branch: v2.4
https://github.com/mongodb/docs/commit/8316e6ffcf503a9e66382ed531380413addbad2b

Comment by Githook User [ 26/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: missed one and spacing
Branch: v2.6
https://github.com/mongodb/docs/commit/c66a2a77ab4100bcad5c1ddf88b3669abeff6ebe

Comment by Githook User [ 26/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove last apiargs files
Branch: v2.6
https://github.com/mongodb/docs/commit/e0fceaae0a32106a1f3ee91ef0087782f81ad5ba

Comment by Githook User [ 26/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove last apiargs files
Branch: v3.0
https://github.com/mongodb/docs/commit/fccfaf1bb0c5c6496a29aa99c9b19d9d3a2926b9

Comment by Githook User [ 26/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove last apiargs files
Branch: v3.2
https://github.com/mongodb/docs/commit/41945a6346c46920f1de150df08a2387099b0942

Comment by Githook User [ 26/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove last apiargs files
Branch: v3.4
https://github.com/mongodb/docs/commit/3fdd3913066ff2c1c083d373debb758722612927

Comment by Githook User [ 26/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove last apiargs files
Branch: v3.6
https://github.com/mongodb/docs/commit/784dce4ee14f14e33daef5921b50056c966c4c4a

Comment by Githook User [ 26/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove last apiargs files
Branch: v4.0
https://github.com/mongodb/docs/commit/51cb9d9b7e34c55ea140d61af844b36bd9df02c8

Comment by Githook User [ 26/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove unused apiargs yaml files
Branch: v4.0
https://github.com/mongodb/docs/commit/0c478fb21b539a4917a5c80a6a8526204ea4c1d6

Comment by Githook User [ 26/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove last apiargs files
Branch: master
https://github.com/mongodb/docs/commit/a563f2b51ad846f3a53500b3e21434657f942525

Comment by Githook User [ 26/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove unused apiargs yaml files
Branch: master
https://github.com/mongodb/docs/commit/57db75bfda56a09a8c5c9a0c0ee15e8e898bbe51

Comment by Githook User [ 20/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for all the rest (except for stragglers)
Branch: v2.6
https://github.com/mongodb/docs/commit/bde4576f787773ce0017a7f77ba1026246fad5f8

Comment by Githook User [ 20/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for all the rest (except for stragglers)
Branch: v2.4
https://github.com/mongodb/docs/commit/b8e29331680261f8e8c9f21e6cf3c2948c7d13fb

Comment by Githook User [ 20/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for all the rest (except for stragglers)
Branch: v3.0
https://github.com/mongodb/docs/commit/3d15782b2d69967197016c2766310f5702b8b391

Comment by Githook User [ 17/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for the rest (minus some stragglers)
Branch: v3.4
https://github.com/mongodb/docs/commit/e2c4a21195d788978e890da298ba0fbd9e56c21d

Comment by Githook User [ 17/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for all the rest (except for stragglers)
Branch: v3.2
https://github.com/mongodb/docs/commit/daaa524b27fab07a6c333c96e9dca5487b31dbee

Comment by Githook User [ 17/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for all the rest
Branch: v3.6
https://github.com/mongodb/docs/commit/d6a65174e5a7000b25bed5928cbd7f256e9ffbdc

Comment by Githook User [ 17/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs cursor. and sh. methods (part 2)
Branch: v3.6
https://github.com/mongodb/docs/commit/193588ed680f4685556925e2bdb06e18eb39fc8f

Comment by Githook User [ 17/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for all the rest
Branch: v4.0
https://github.com/mongodb/docs/commit/a92ada8152bd71c4a6d16a619a86181acb082f4c

Comment by Githook User [ 17/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: trivial spacing issue with after removing apiargs
Branch: master
https://github.com/mongodb/docs/commit/bd0dbe97017d71b98d7fa4bbc41396bbaf9a4ebd

Comment by Githook User [ 17/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove apiargs yaml for apiargs (all the rest)
Branch: master
https://github.com/mongodb/docs/commit/a5d0b21b38168ddf4d49c2b22ec13879a374fe8e

Comment by Githook User [ 17/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: trivial spacing issue with after removing apiargs
Branch: master
https://github.com/mongodb/docs/commit/f8cee585031a24b68040d404d92a1572964ae86f

Comment by Githook User [ 17/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs cursor. and sh. methods (part 2)
Branch: v4.0
https://github.com/mongodb/docs/commit/b1a6299df07a21939bbb8c14ea13e4047f92d2e5

Comment by Githook User [ 17/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs sh. methods (part 4)
Branch: master
https://github.com/mongodb/docs/commit/ee42136202c28501a20d68575f3da78c5ea20df1

Comment by Githook User [ 17/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs cursor methods (part 3)
Branch: master
https://github.com/mongodb/docs/commit/283433890e179ea244b9b9f73e7ec2d272ab7491

Comment by Githook User [ 16/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: v2.4
https://github.com/mongodb/docs/commit/db443166c0d83961028690b6035e4ab6bdfdec21

Comment by Githook User [ 16/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: v2.6
https://github.com/mongodb/docs/commit/865bce0825e2164a4fb13d00d4327d06f2b6f2ea

Comment by Githook User [ 16/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: v3.0
https://github.com/mongodb/docs/commit/9bd73e99bde2484f2d64e5f935b8990a88440947

Comment by Githook User [ 16/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: v3.2
https://github.com/mongodb/docs/commit/74e82e939d33b885bde940e80b00d0b1d479a735

Comment by Githook User [ 16/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: v3.4
https://github.com/mongodb/docs/commit/f8a9d7d870b6aaef7202624fcab603823e70a002

Comment by Githook User [ 16/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: v3.6
https://github.com/mongodb/docs/commit/348df549aac5dd9621be4f3d11844791b27c7509

Comment by Githook User [ 16/Sep/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: v4.0
https://github.com/mongodb/docs/commit/5a54c75c6dc55f4670b1051200a4582420ec9117

Comment by Githook User [ 16/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: master
https://github.com/mongodb/docs/commit/adeba0103fe463b2cc89c8eb68a52cf7af1f3334

Comment by Githook User [ 16/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: master
https://github.com/mongodb/docs/commit/467612cd14dc0942caf9d59d5d1955d2ca630502

Comment by Githook User [ 15/Sep/19 ]

Author:

{'username': 'kay-kim', 'email': 'kay.kim@10gen.com', 'name': 'Kay Kim'}

Message: DOCS-12889: Remove apiargs yaml for apiargs-command (part 2)
Branch: v3.0-apiargs-12889
https://github.com/mongodb/docs/commit/e400a3d04602ecdd4079012ad076913346f6743a

Comment by Githook User [ 01/Aug/19 ]

Author:

{'name': 'Kay Kim', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}

Message: DOCS-12889: remove apiargs for update methods
Branch: master
https://github.com/mongodb/docs/commit/a8b5210cab7efbe361a48ffadf13656b7b653e88

Comment by Githook User [ 13/Jul/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove apiargs yaml for agg operators (part 1)
Branch: v3.4
https://github.com/mongodb/docs/commit/284ca01b7e8e5b332d3e662b90f47a13648db8a2

Comment by Githook User [ 13/Jul/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove apiargs yaml for agg operators (part 1)
Branch: v3.6
https://github.com/mongodb/docs/commit/61410b4c8c8bee1eb2939d7489b28b1d55800004

Comment by Githook User [ 12/Jul/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12889: Remove apiargs yaml for agg operators (part 1)
Branch: v4.0
https://github.com/mongodb/docs/commit/91d3da5472fb24771d7ceafde8af9658699a8202

Comment by Githook User [ 12/Jul/19 ]

Author:

{'name': 'Kay Kim', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}

Message: DOCS-12889: Remove apiargs yaml for agg operators (part 1)
Branch: master
https://github.com/mongodb/docs/commit/04da6cad9b11b1133cc3dd4a41b337507af87fc9

Generated at Thu Feb 08 08:06:23 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.