Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[No QA] Add documentation about HelpDot deploys #9762

Merged
merged 2 commits into from
Jul 11, 2022
Merged

[No QA] Add documentation about HelpDot deploys #9762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8830e3a
Add stuff about docs to main README
roryabraham Jul 7, 2022
5807db4
Add docs on HelpDot deploy
roryabraham Jul 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,9 @@ created to house a collection of items in plural form and using camelCase (eg: p
- pages: These are components that define pages in the app. The component that defines the page itself should be named
`<pageName>Page` if there are components used only inside one page, they should live in its own directory named after the `<pageName>`.
- styles: These files define styles used among components/pages
- contributingGuides: This is just a set of markdown files providing guides and insights to aid developers in learning how to contribute to this repo.

**Note:** There is also a directory called `/docs`, which houses the Expensify Help site. It's a static site that's built with Jekyll and hosted on GitHub Pages.

## File naming/structure
Files should be named after the component/function/constants they export, respecting the casing used for it. ie:
Expand Down
13 changes: 11 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# Welcome to the Expensify Help site

Expensify Help is mainly composed of static HTML (`.html`) and Markdown (`.md`) files. We use [Jekyll](https://jekyllrb.com/) to generate a static site from those HTML and Markdown files.
[Expensify Help](https://help.expensify.com/) is mainly composed of static HTML (`.html`) and Markdown (`.md`) files. We use [Jekyll](https://jekyllrb.com/) to generate a static site from those HTML and Markdown files.

# Test locally
### Table of Contents
* [Testing Locally](#testing-locally)
* [How the project is structured](#how-the-project-is-structured)
* [How to add a new Article](#how-to-add-a-new-article)
* [How the site is deployed](#how-the-site-is-deployed)

# Testing Locally

## Pre-requisites

Expand Down Expand Up @@ -168,3 +174,6 @@ Add the next HTML block inside of the corresponding Stage title anchor:
```

Where `./request-money/SmartScan` will be the relative path of the file name (exactly the same as in the `Add a Card button` example above).

# How the site is deployed
This site is hosted on GitHub Pages. GitHub Pages has a built-in Jekyll integration, and we have it configured such that whenever code is merged to main, GitHub will automatically build the Jekyll site housed in the `/docs` directory and deploy it straight to production. The help site is publicly discoverable at https://help.expensify.com/