diff --git a/.github/workflows/deployHelpSite.yml b/.github/workflows/deployHelpSite.yml deleted file mode 100644 index 08ab13b3115a..000000000000 --- a/.github/workflows/deployHelpSite.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: Deploy Help Site -on: - push: - branches: [main] - -jobs: - buildAndDeploy: - runs-on: ubuntu-latest - env: - BUNDLE_GEMFILE: ${{ github.workspace }}/help/Gemfile - steps: - - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b - - - uses: ruby/setup-ruby@08245253a76fa4d1e459b7809579c62bd9eb718a - with: - ruby-version: 3.0 - bundler-cache: true - - - name: Build - run: cd help && bundle exec jekyll build - - - name: Deploy - uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 - with: - github_token: ${{ github.token }} - publish_dir: ./help/_site - - - if: ${{ failure() }} - uses: Expensify/App/.github/actions/composite/announceFailedWorkflowInSlack@main - with: - SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }} diff --git a/CLA.md b/CLA.md deleted file mode 100644 index 9a78922d017c..000000000000 --- a/CLA.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/CLA.md). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 23ca1a953092..000000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/CONTRIBUTING.md). diff --git a/FORMS.md b/FORMS.md deleted file mode 100644 index c6d36ff480be..000000000000 --- a/FORMS.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/FORMS.md). diff --git a/HOW_TO_CREATE_A_PLAN.md b/HOW_TO_CREATE_A_PLAN.md deleted file mode 100644 index ae0616ed6157..000000000000 --- a/HOW_TO_CREATE_A_PLAN.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/HOW_TO_CREATE_A_PLAN.md). diff --git a/OfflineUX.md b/OfflineUX.md deleted file mode 100644 index a11c1d72f0bc..000000000000 --- a/OfflineUX.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/OFFLINE_UX.md). diff --git a/PERFORMANCE.md b/PERFORMANCE.md deleted file mode 100644 index 2356a29a8a17..000000000000 --- a/PERFORMANCE.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/PERFORMANCE.md). diff --git a/PR_REVIEW_GUIDELINES.md b/PR_REVIEW_GUIDELINES.md index fd73c3864ba1..9ae9f5e3d7a5 100644 --- 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 index 198a9cd7eed4..76c6bbbb6df3 100644 --- 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 deleted file mode 100644 index 9f4a3c1f6c1c..000000000000 --- a/STORYBOOK.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/STORYBOOK.md). diff --git a/STYLE.md b/STYLE.md deleted file mode 100644 index 5f29cabe23f1..000000000000 --- a/STYLE.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/STYLE.md). diff --git a/STYLING.md b/STYLING.md deleted file mode 100644 index bfe588069ec6..000000000000 --- a/STYLING.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/STYLING.md). diff --git a/TESTING_MACOS_AND_IOS.md b/TESTING_MACOS_AND_IOS.md deleted file mode 100644 index cae2cdbc2992..000000000000 --- a/TESTING_MACOS_AND_IOS.md +++ /dev/null @@ -1 +0,0 @@ -This file has been moved [here](./docs/TESTING_MACOS_AND_IOS.md). diff --git a/docs/API.md b/contributingGuides/API.md similarity index 100% rename from docs/API.md rename to contributingGuides/API.md diff --git a/docs/CLA.md b/contributingGuides/CLA.md similarity index 100% rename from docs/CLA.md rename to contributingGuides/CLA.md diff --git a/docs/CONTRIBUTING.md b/contributingGuides/CONTRIBUTING.md similarity index 100% rename from docs/CONTRIBUTING.md rename to contributingGuides/CONTRIBUTING.md diff --git a/docs/FORMS.md b/contributingGuides/FORMS.md similarity index 100% rename from docs/FORMS.md rename to contributingGuides/FORMS.md diff --git a/docs/HOW_TO_CREATE_A_PLAN.md b/contributingGuides/HOW_TO_CREATE_A_PLAN.md similarity index 100% rename from docs/HOW_TO_CREATE_A_PLAN.md rename to contributingGuides/HOW_TO_CREATE_A_PLAN.md diff --git a/docs/OFFLINE_UX.md b/contributingGuides/OFFLINE_UX.md similarity index 99% rename from docs/OFFLINE_UX.md rename to contributingGuides/OFFLINE_UX.md index 48bd6c12d894..ea61fac8a5b8 100644 --- a/docs/OFFLINE_UX.md +++ b/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 b/contributingGuides/OfflineUX_Patterns_Flowchart.png similarity index 100% rename from docs/OfflineUX_Patterns_Flowchart.png rename to contributingGuides/OfflineUX_Patterns_Flowchart.png diff --git a/docs/PERFORMANCE.md b/contributingGuides/PERFORMANCE.md similarity index 100% rename from docs/PERFORMANCE.md rename to contributingGuides/PERFORMANCE.md diff --git a/docs/PR_REVIEW_GUIDELINES.md b/contributingGuides/PR_REVIEW_GUIDELINES.md similarity index 100% rename from docs/PR_REVIEW_GUIDELINES.md rename to contributingGuides/PR_REVIEW_GUIDELINES.md diff --git a/docs/STORYBOOK.md b/contributingGuides/STORYBOOK.md similarity index 100% rename from docs/STORYBOOK.md rename to contributingGuides/STORYBOOK.md diff --git a/docs/STYLE.md b/contributingGuides/STYLE.md similarity index 100% rename from docs/STYLE.md rename to contributingGuides/STYLE.md diff --git a/docs/STYLING.md b/contributingGuides/STYLING.md similarity index 100% rename from docs/STYLING.md rename to contributingGuides/STYLING.md diff --git a/docs/TESTING_MACOS_AND_IOS.md b/contributingGuides/TESTING_MACOS_AND_IOS.md similarity index 100% rename from docs/TESTING_MACOS_AND_IOS.md rename to contributingGuides/TESTING_MACOS_AND_IOS.md diff --git a/docs/data_flow.png b/contributingGuides/data_flow.png similarity index 100% rename from docs/data_flow.png rename to contributingGuides/data_flow.png diff --git a/help/.gitignore b/docs/.gitignore similarity index 100% rename from help/.gitignore rename to docs/.gitignore diff --git a/help/404.html b/docs/404.html similarity index 100% rename from help/404.html rename to docs/404.html diff --git a/help/Gemfile b/docs/Gemfile similarity index 100% rename from help/Gemfile rename to docs/Gemfile diff --git a/help/Gemfile.lock b/docs/Gemfile.lock similarity index 100% rename from help/Gemfile.lock rename to docs/Gemfile.lock diff --git a/help/README.md b/docs/README.md similarity index 94% rename from help/README.md rename to docs/README.md index 9eac0ee34f56..b9b234ae74e8 100644 --- a/help/README.md +++ b/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
@@ -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)): ```
  • Request Money diff --git a/help/TEMPLATE.md b/docs/TEMPLATE.md similarity index 100% rename from help/TEMPLATE.md rename to docs/TEMPLATE.md diff --git a/help/_config.yml b/docs/_config.yml similarity index 100% rename from help/_config.yml rename to docs/_config.yml diff --git a/help/_includes/home-navigation-tree.html b/docs/_includes/home-navigation-tree.html similarity index 100% rename from help/_includes/home-navigation-tree.html rename to docs/_includes/home-navigation-tree.html diff --git a/help/_includes/request-money-navigation-tree.html b/docs/_includes/request-money-navigation-tree.html similarity index 93% rename from help/_includes/request-money-navigation-tree.html rename to docs/_includes/request-money-navigation-tree.html index cc9146915e4d..297dcaa3b6dd 100644 --- a/help/_includes/request-money-navigation-tree.html +++ b/docs/_includes/request-money-navigation-tree.html @@ -12,7 +12,7 @@
    • - \ No newline at end of file + diff --git a/help/_includes/send-money-navigation-tree.html b/docs/_includes/send-money-navigation-tree.html similarity index 89% rename from help/_includes/send-money-navigation-tree.html rename to docs/_includes/send-money-navigation-tree.html index e4f952303b8e..9b42705d6282 100644 --- a/help/_includes/send-money-navigation-tree.html +++ b/docs/_includes/send-money-navigation-tree.html @@ -8,7 +8,7 @@ @@ -16,4 +16,4 @@ Request Money - \ No newline at end of file + diff --git a/help/_layouts/default.html b/docs/_layouts/default.html similarity index 100% rename from help/_layouts/default.html rename to docs/_layouts/default.html diff --git a/help/articles/request-money/SmartScan.md b/docs/articles/request-money/SmartScan.md similarity index 100% rename from help/articles/request-money/SmartScan.md rename to docs/articles/request-money/SmartScan.md diff --git a/help/assets/css/fonts.css b/docs/assets/css/fonts.css similarity index 100% rename from help/assets/css/fonts.css rename to docs/assets/css/fonts.css diff --git a/help/assets/css/styles.scss b/docs/assets/css/styles.scss similarity index 100% rename from help/assets/css/styles.scss rename to docs/assets/css/styles.scss diff --git a/help/assets/images/expensify-help.svg b/docs/assets/images/expensify-help.svg similarity index 100% rename from help/assets/images/expensify-help.svg rename to docs/assets/images/expensify-help.svg diff --git a/help/assets/js/main.js b/docs/assets/js/main.js similarity index 100% rename from help/assets/js/main.js rename to docs/assets/js/main.js diff --git a/help/hubs/request-money.html b/docs/hubs/request-money.html similarity index 89% rename from help/hubs/request-money.html rename to docs/hubs/request-money.html index 4da42d793761..41f9163ab0b3 100644 --- a/help/hubs/request-money.html +++ b/docs/hubs/request-money.html @@ -10,7 +10,7 @@

    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, - +

    diff --git a/help/hubs/send-money.html b/docs/hubs/send-money.html similarity index 81% rename from help/hubs/send-money.html rename to docs/hubs/send-money.html index 203fc50c723d..94079fe3b8ca 100644 --- a/help/hubs/send-money.html +++ b/docs/hubs/send-money.html @@ -10,4 +10,4 @@

    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, - + diff --git a/help/index.html b/docs/index.html similarity index 100% rename from help/index.html rename to docs/index.html