Move docs to contributingGuides and help to docs

Delgee · Jul 6, 2022 · 7a67954 · 7a67954
1 parent 32e67da
commit 7a67954
Show file tree

Hide file tree

Showing 46 changed files with 20 additions and 61 deletions.
diff --git a/.github/workflows/deployHelpSite.yml b/.github/workflows/deployHelpSite.yml
diff --git a/CLA.md b/CLA.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/FORMS.md b/FORMS.md
diff --git a/HOW_TO_CREATE_A_PLAN.md b/HOW_TO_CREATE_A_PLAN.md
diff --git a/OfflineUX.md b/OfflineUX.md
diff --git a/PERFORMANCE.md b/PERFORMANCE.md
diff --git a/PR_REVIEW_GUIDELINES.md b/PR_REVIEW_GUIDELINES.md
@@ -1 +1 @@
-This file has been moved [here](./docs/PR_REVIEW_GUIDELINES.md).
+This file has been moved [here](contributingGuides/PR_REVIEW_GUIDELINES.md).
diff --git a/README.md b/README.md
@@ -19,11 +19,11 @@
 * [Deploying](#deploying)
 
 #### Additional Reading
-* [API Details](docs/API.md)
-* [Offline First](./docs/OFFLINE_UX.md)
-* [Contributing to Expensify](./docs/CONTRIBUTING.md)
-* [Expensify Code of Conduct](./docs/CODE_OF_CONDUCT.md)
-* [Contributor License Agreement](./docs/CLA.md)
+* [API Details](contributingGuides/API.md)
+* [Offline First](contributingGuides/OFFLINE_UX.md)
+* [Contributing to Expensify](contributingGuides/CONTRIBUTING.md)
+* [Expensify Code of Conduct](contributingGuides/CODE_OF_CONDUCT.md)
+* [Contributor License Agreement](contributingGuides/CLA.md)
 
 ----
 
@@ -86,7 +86,7 @@ variables referenced here get updated since your local `.env` file is ignored.
    requests to the backend. External contributors should set this to `true` otherwise they'll have CORS errors.
    If you don't want to start the proxy server set this explicitly to `false`
 - `CAPTURE_METRICS` (optional) - Set this to `true` to capture performance metrics and see them in Flipper
-   see [PERFORMANCE.md](./docs/PERFORMANCE.md#performance-metrics-opt-in-on-local-release-builds) for more information
+   see [PERFORMANCE.md](contributingGuides/PERFORMANCE.md#performance-metrics-opt-in-on-local-release-builds) for more information
 - `ONYX_METRICS` (optional) - Set this to `true` to capture even more performance metrics and see them in Flipper
    see [React-Native-Onyx#benchmarks](https://github.com/Expensify/react-native-onyx#benchmarks) for more information
 
@@ -286,9 +286,9 @@ This application is built with the following principles.
     4. Brain pushes data into UI inputs (Device input -> React component).
     5. UI inputs push data to the server (React component -> Action -> XHR to server).
     6. Go to 1
-    ![New Expensify Data Flow Chart](/docs/data_flow.png)
+    ![New Expensify Data Flow Chart](/contributingGuides/data_flow.png)
 1. **Offline first**
-    - Be sure to read [OFFLINE_UX.md](./docs/OFFLINE_UX.md)!
+    - Be sure to read [OFFLINE_UX.md](contributingGuides/OFFLINE_UX.md)!
     - All data that is brought into the app and is necessary to display the app when offline should be stored on disk in persistent storage (eg. localStorage on browser platforms). [AsyncStorage](https://reactnative.dev/docs/asyncstorage) is a cross-platform abstraction layer that is used to access persistent storage.
     - All data that is displayed, comes from persistent storage.
 1. **UI Binds to data on disk**

diff --git a/STORYBOOK.md b/STORYBOOK.md
diff --git a/STYLE.md b/STYLE.md
diff --git a/STYLING.md b/STYLING.md
diff --git a/TESTING_MACOS_AND_IOS.md b/TESTING_MACOS_AND_IOS.md
diff --git a/docs/API.md → contributingGuides/API.md b/docs/API.md → contributingGuides/API.md
diff --git a/docs/CLA.md → contributingGuides/CLA.md b/docs/CLA.md → contributingGuides/CLA.md
diff --git a/docs/CONTRIBUTING.md → contributingGuides/CONTRIBUTING.md b/docs/CONTRIBUTING.md → contributingGuides/CONTRIBUTING.md
diff --git a/docs/FORMS.md → contributingGuides/FORMS.md b/docs/FORMS.md → contributingGuides/FORMS.md
diff --git a/docs/HOW_TO_CREATE_A_PLAN.md → contributingGuides/HOW_TO_CREATE_A_PLAN.md b/docs/HOW_TO_CREATE_A_PLAN.md → contributingGuides/HOW_TO_CREATE_A_PLAN.md
diff --git a/docs/OFFLINE_UX.md → contributingGuides/OFFLINE_UX.md b/docs/OFFLINE_UX.md → contributingGuides/OFFLINE_UX.md
@@ -95,7 +95,7 @@ This pattern blocks the user from interacting with an entire page.
 
 The following flowchart can be used to determine which UX pattern should be used.
 
-![New Expensify Data Flow Chart](/docs/OfflineUX_Patterns_Flowchart.png)
+![New Expensify Data Flow Chart](/contributingGuides/OfflineUX_Patterns_Flowchart.png)
 
 ### Answering Questions on the Flow Chart
 

diff --git a/docs/OfflineUX_Patterns_Flowchart.png → ...ngGuides/OfflineUX_Patterns_Flowchart.png b/docs/OfflineUX_Patterns_Flowchart.png → ...ngGuides/OfflineUX_Patterns_Flowchart.png
diff --git a/docs/PERFORMANCE.md → contributingGuides/PERFORMANCE.md b/docs/PERFORMANCE.md → contributingGuides/PERFORMANCE.md
diff --git a/docs/PR_REVIEW_GUIDELINES.md → contributingGuides/PR_REVIEW_GUIDELINES.md b/docs/PR_REVIEW_GUIDELINES.md → contributingGuides/PR_REVIEW_GUIDELINES.md
diff --git a/docs/STORYBOOK.md → contributingGuides/STORYBOOK.md b/docs/STORYBOOK.md → contributingGuides/STORYBOOK.md
diff --git a/docs/STYLE.md → contributingGuides/STYLE.md b/docs/STYLE.md → contributingGuides/STYLE.md
diff --git a/docs/STYLING.md → contributingGuides/STYLING.md b/docs/STYLING.md → contributingGuides/STYLING.md
diff --git a/docs/TESTING_MACOS_AND_IOS.md → contributingGuides/TESTING_MACOS_AND_IOS.md b/docs/TESTING_MACOS_AND_IOS.md → contributingGuides/TESTING_MACOS_AND_IOS.md
diff --git a/docs/data_flow.png → contributingGuides/data_flow.png b/docs/data_flow.png → contributingGuides/data_flow.png
diff --git a/help/.gitignore → docs/.gitignore b/help/.gitignore → docs/.gitignore
diff --git a/help/404.html → docs/404.html b/help/404.html → docs/404.html
diff --git a/help/Gemfile → docs/Gemfile b/help/Gemfile → docs/Gemfile
diff --git a/help/Gemfile.lock → docs/Gemfile.lock b/help/Gemfile.lock → docs/Gemfile.lock
diff --git a/help/README.md → docs/README.md b/help/README.md → docs/README.md
@@ -27,7 +27,7 @@ bundle install
 # How the project is structured
 
 The [help](https://github.com/Expensify/App/tree/e6cea38ef22f83ae4730a34a9281d8962388dff8/help) folder will contain the following main folders:
-- *_layouts*: This contains HTML templates used by Jekyll to create pages in the static site. For now it has only one file ([default.html](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/help/_layouts/default.html)) which will render the common HTML elements and the assets on every page. It also supports the use of the [liquid template language](https://shopify.github.io/liquid/).
+- *_layouts*: This contains HTML templates used by Jekyll to create pages in the static site. For now it has only one file ([default.html](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/docs/_layouts/default.html)) which will render the common HTML elements and the assets on every page. It also supports the use of the [liquid template language](https://shopify.github.io/liquid/).
 - *_includes*: Contains HTML content that can be reused on different pages. For now, it contains various html elements that are used to populate the left-hand-nav (LHN).
 - *assets*: it will contain the three sub-folders css, images, and js.
   - The css folder can contain either .css or .sass files (where SASS files will be processed by Jekyll and it will generate a CSS file in an output folder also generated by Jekyll).
@@ -43,7 +43,7 @@ More details about the Jekyll project structure can be found [here](https://jeky
 
 ## Add content
 
-Copy the [template](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/help/TEMPLATE.md) file and rename it with the name of the article title, i.e. [SmartScan.md](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/help/articles/request-money/request-money/SmartScan.md) (you can use dashes for spaces in the file name if it's needed) and put the new file inside of the respective hub folder or sub-folder. The title will be rendered automatically according to the filename (the dashes will be removed in the generated site page).
+Copy the [template](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/docs/TEMPLATE.md) file and rename it with the name of the article title, i.e. [SmartScan.md](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/docs/articles/request-money/request-money/SmartScan.md) (you can use dashes for spaces in the file name if it's needed) and put the new file inside of the respective hub folder or sub-folder. The title will be rendered automatically according to the filename (the dashes will be removed in the generated site page).
 
 The sections of the article will be filled and nested automatically in the LHN, just ensure to use the [heading markdown tags](https://www.markdownguide.org/cheat-sheet/) correctly.
 
@@ -110,7 +110,7 @@ If it's required, you can add a new row of Card buttons with the following HTML
 
 A card button is the box that contains the article title and the caret right icon `>`. It navigates to the article when it's pressed.
 
-In order to add a new Card button in the respective hub page ([send-money/index.html](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/help/articles/send-money/index.html) or [request-money/index.html](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/help/articles/request-money/index.html)) just copy and pase the following Card element:
+In order to add a new Card button in the respective hub page ([send-money/index.html](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/docs/articles/send-money/index.html) or [request-money/index.html](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/docs/articles/request-money/index.html)) just copy and pase the following Card element:
 
 ```html
 <div class="card" onclick="openArticle('./request-money/SmartScan')">
@@ -147,7 +147,7 @@ There are 2 main components in the LHN page associated with the hub you're addin
 
 ### Add a new Stage title anchor (optional)
 
-Just add copy and paste the following HTML block in the corresponding navigation tree file (either for [Request Money](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/help/_includes/request-money-navigation-tree.html) or [Send Money](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/help/_includes/send-money-navigation-tree.html)):
+Just add copy and paste the following HTML block in the corresponding navigation tree file (either for [Request Money](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/docs/_includes/request-money-navigation-tree.html) or [Send Money](https://github.com/Expensify/App/blob/e6cea38ef22f83ae4730a34a9281d8962388dff8/docs/_includes/send-money-navigation-tree.html)):
 
 ```
 <li><a href="#request-money">Request Money</a>

diff --git a/help/TEMPLATE.md → docs/TEMPLATE.md b/help/TEMPLATE.md → docs/TEMPLATE.md
diff --git a/help/_config.yml → docs/_config.yml b/help/_config.yml → docs/_config.yml
diff --git a/help/_includes/home-navigation-tree.html → docs/_includes/home-navigation-tree.html b/help/_includes/home-navigation-tree.html → docs/_includes/home-navigation-tree.html
diff --git a/...cludes/request-money-navigation-tree.html → ...cludes/request-money-navigation-tree.html b/...cludes/request-money-navigation-tree.html → ...cludes/request-money-navigation-tree.html
@@ -12,7 +12,7 @@
         <ul class="nested-treeview">
 
             <!-- Add content below, more instructions in the README.md file
-                https://github.com/Expensify/App/blob/44b0fdad50da2c368e67ee6ae6951ad699f6125d/help/README.md#add-a-new-entry-in-the-lhn-and-hub-page
+                https://github.com/Expensify/App/blob/44b0fdad50da2c368e67ee6ae6951ad699f6125d/docs/README.md#add-a-new-entry-in-the-lhn-and-hub-page
             -->
 
             <!-- Stage title anchor -->
@@ -27,4 +27,4 @@
             <!-- More Stage title anchors here... -->
         </ul>
     </li>
-</ul>
+</ul>
diff --git a/..._includes/send-money-navigation-tree.html → ..._includes/send-money-navigation-tree.html b/..._includes/send-money-navigation-tree.html → ..._includes/send-money-navigation-tree.html
@@ -8,12 +8,12 @@
         <ul class="nested-treeview">
 
             <!-- Add content below, more instructions in the README.md file
-                https://github.com/Expensify/App/blob/44b0fdad50da2c368e67ee6ae6951ad699f6125d/help/README.md#add-a-new-entry-in-the-lhn-and-hub-page
+                https://github.com/Expensify/App/blob/44b0fdad50da2c368e67ee6ae6951ad699f6125d/docs/README.md#add-a-new-entry-in-the-lhn-and-hub-page
             -->
         </ul>
     </li>
     <li>
         <i class="fa-solid fa-angle-right caret-icon"></i>
         <a href="/hubs/request-money">Request Money</a>
     </li>
-</ul>
+</ul>
diff --git a/help/_layouts/default.html → docs/_layouts/default.html b/help/_layouts/default.html → docs/_layouts/default.html
diff --git a/help/articles/request-money/SmartScan.md → docs/articles/request-money/SmartScan.md b/help/articles/request-money/SmartScan.md → docs/articles/request-money/SmartScan.md
diff --git a/help/assets/css/fonts.css → docs/assets/css/fonts.css b/help/assets/css/fonts.css → docs/assets/css/fonts.css
diff --git a/help/assets/css/styles.scss → docs/assets/css/styles.scss b/help/assets/css/styles.scss → docs/assets/css/styles.scss
diff --git a/help/assets/images/expensify-help.svg → docs/assets/images/expensify-help.svg b/help/assets/images/expensify-help.svg → docs/assets/images/expensify-help.svg
diff --git a/help/assets/js/main.js → docs/assets/js/main.js b/help/assets/js/main.js → docs/assets/js/main.js
diff --git a/help/hubs/request-money.html → docs/hubs/request-money.html b/help/hubs/request-money.html → docs/hubs/request-money.html
@@ -10,7 +10,7 @@ <h1>
 <!-- TODO: remove the following text, added just for testing -->
 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur hendrerit euismod dui, nec fermentum urna porta ultrices. Nullam sed vestibulum purus, in auctor libero. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Maecenas dolor metus,
 
-<!-- Add content below, more instructions here https://github.com/Expensify/App/blob/2e1b8e9c20106484cacca813473946ab492d3f5b/help/README.md#add-a-new-entry-in-the-hub-page -->
+<!-- Add content below, more instructions here https://github.com/Expensify/App/blob/2e1b8e9c20106484cacca813473946ab492d3f5b/docs/README.md#add-a-new-entry-in-the-hub-page -->
 
 <!-- Stage title -->
 <h2 id="request-money">

diff --git a/help/hubs/send-money.html → docs/hubs/send-money.html b/help/hubs/send-money.html → docs/hubs/send-money.html
@@ -10,4 +10,4 @@ <h1>
 <!-- TODO: remove the following text, added just for testing -->
 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur hendrerit euismod dui, nec fermentum urna porta ultrices. Nullam sed vestibulum purus, in auctor libero. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Maecenas dolor metus,
 
-<!-- Add content below, more instructions here https://github.com/Expensify/App/blob/2e1b8e9c20106484cacca813473946ab492d3f5b/help/README.md#add-a-new-entry-in-the-hub-page -->
+<!-- Add content below, more instructions here https://github.com/Expensify/App/blob/2e1b8e9c20106484cacca813473946ab492d3f5b/docs/README.md#add-a-new-entry-in-the-hub-page -->
diff --git a/help/index.html → docs/index.html b/help/index.html → docs/index.html
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		This file has been moved [here](./docs/PR_REVIEW_GUIDELINES.md).
		This file has been moved [here](contributingGuides/PR_REVIEW_GUIDELINES.md).