[SERVER-37414] Remove branch-specific Github wiki sections in favor of docs/ folder Created: 01/Oct/18  Updated: 29/Oct/23  Resolved: 17/Mar/20

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: 4.7.0

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

Issue Links:
Related
related to SERVER-47689 docs/index.md needs to be populated w... Closed
is related to SERVER-46547 Update Server Logging Rules and move ... Closed
Backwards Compatibility: Fully Compatible
Sprint: Service Arch 2018-10-22, Dev Tools 2018-11-19, Service Arch 2018-11-05, Dev Tools 2018-12-03
Participants:

 Description   

The Github wiki cannot be directly tied to branches or commits and is (obviously) not available to those trying to compile without connection to the internet. We should move the existing markdown pages in the wiki into our docs folder and replace the wiki with a single page that contains a set of links to our docs folder for each major release and master.



 Comments   
Comment by Githook User [ 17/Mar/20 ]

Author:

{'name': 'Ian Whalen', 'email': 'ian@mongodb.com', 'username': 'IanWhalen'}

Message: SERVER-37414 Move branch-specific docs from GitHub Wiki into repo
Branch: master
https://github.com/mongodb/mongo/commit/fb26a7fb81b1c6986ebfebbdd9289297fbfd16aa

Comment by Ian Whalen (Inactive) [ 28/Feb/20 ]

this is low-value enough that I'm sitting on it until we branch, at which point I will merge.

Comment by Andrew Morrow (Inactive) [ 10/Feb/20 ]

ian.whalen - Sure, happy to review, as long as I can be agnostic as to the content of the pages.

Comment by Ian Whalen (Inactive) [ 06/Feb/20 ]

acm blast from the past!

If I put up a CR to move the below sections into basically identical markdown files inside of /docs, would you review?

Exception Architecture
Memory Management
Parsing Stack Traces
String Manipulation

I've also reached out to sharding and dev tools about the sharding and logging 'internals' pages, respectively.

Comment by Benjamin Caimano (Inactive) [ 03/Oct/18 ]

So I took a minute to walk through the github wiki and noticed the following:

  • The "Getting Started" and "Code Style" sections are completely branch independent with the exception of the last two sections in "Server Code Style".
  • The "Building" and "Testing" sections are branch specific.
  • We don't seem to have documentation on our c++ integration tests.
  • We do not have a "Lint" section. We should probably move those two sections in "Server Code Style" into a separate page and expand them. We're missing our mypy/yapf linter and the mongo-lint.
  • The majority of the "Server Internals" section is branch specific and explicitly mentions 3.4. This should probably be farmed out to individual server teams to refresh.

ramon.fernandez, does seem correct to you?

Comment by Daniel Pasette (Inactive) [ 01/Oct/18 ]

huge +1

Generated at Thu Feb 08 04:45:55 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.