Update docs

nerevu · Apr 25, 2020 · d2db83c · d2db83c
1 parent bcba9e5
commit d2db83c
Show file tree

Hide file tree

Showing 8 changed files with 77 additions and 52 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -57,3 +57,11 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+
+html_theme_options = {
+    # 'logo': 'logo.png',
+    # 'touch_icon': 'alabaster',
+    'fixed_sidebar': True,
+    'show_relbar_bottom': True,
+    'show_related': True
+}
diff --git a/docs/finance.md b/docs/finance.md
diff --git a/docs/getting-started.md → docs/getting-setup.md b/docs/getting-started.md → docs/getting-setup.md
@@ -1,4 +1,4 @@
-# Getting Started
+# Getting Setup
 
 This section contains a several topics to help a new user get started during their first week at Nerevu.
 
@@ -44,30 +44,7 @@ pip install -r requirements.txt -r dev-requirements.txt
 
 ## Fastmail
 
-### Access your new account
-
-1. [Login to Fastmail](https://www.fastmail.com/login) with the following information
-
-- username: [first initial][last name]@nerevu.com, e.g., `rcummings@nerevu.com`
-- password: separately emailed to you
-
-2. [Change your password](https://www.fastmail.com/help/account/password.html)
-
-### Create App password to connect Fastmail to Cloze
-
-Fastmail comes under `Other Email` type in Cloze, and therefore giving access to a 3rd-party application, like Cloze, would need an app password that will be used by that application.
-
-1. From your Fastmail dashboard, open the dropdown menu at the top-left corner.
-2. Click on `Settings` and then on `Passwords & Security`.
-3. Look for `App Passwords` in this page and click on `Manage →`.
-4. Enter your password at the top of this page and click on `Unlock`.
-5. Click on `New App Password` button.
-6. Open the dropdown adjacent to `Name`, select `Custom` and enter `Cloze` in the input box.
-7. Make sure that the `Access` field is set to `Mails, Contacts & Calendars`.
-8. Click on `Generate Password` and make a temporary note of it, as it will not be displayed again once you click on `Done`.
-9. Use this password when you add this account in Cloze (Refer to [Linking various Accounts and Services to Cloze](#linking-various-accounts-and-services-to-cloze)).
-
-### Setup Fastmail Calendar Sync
+### Calendar Sync
 
 Nerevu Group uses Fastmail Calendar to keep everyone up to date on events that are happening. This section will show you how to sync your existing calendars so that they update Fastmail. In general, there are two options for syncing with your teammates:
 
@@ -105,7 +82,7 @@ KeePass is the Password Manager that Nerevu Group uses to keep usernames and pas
 
 1. Add keyfile to your [encrypted volume](#encrypted-volume-configuration)
 
-  - download `.key` keyfile (link will be given to you)
+  - download your `.key` keyfile (link will be given to you)
   - cut and paste the downloaded keyfile to your encrypted volume
   - make sure the keyfile does not exist anywhere else on your computer except in the encrypted volume (for security reasons)
 
@@ -129,7 +106,7 @@ You can see how to use it by looking at the [`commissioner-api` README](https://
 
 Visit [Ngrok's website](https://ngrok.com/) to learn more about it.
 
-## Linking various Accounts and Services to Cloze
+## Cloze
 
 See [this article for pictures](https://help.cloze.com/help/how-do-i-connect-dropbox-to-cloze)
 
@@ -147,7 +124,21 @@ See [this article for pictures](https://help.cloze.com/help/how-do-i-connect-dro
 7. Sign in to the service using Nerevu credentials.
 8. Review the permissions and click on `Allow`, when prompted.
 
-## Google Sheets API setup
+### Fastmail app password
+
+Fastmail comes under `Other Email` type in Cloze, and therefore giving access to a 3rd-party application, like Cloze, would need an app password that will be used by that application.
+
+1. From your Fastmail dashboard, open the dropdown menu at the top-left corner.
+2. Click on `Settings` and then on `Passwords & Security`.
+3. Look for `App Passwords` in this page and click on `Manage →`.
+4. Enter your password at the top of this page and click on `Unlock`.
+5. Click on `New App Password` button.
+6. Open the dropdown adjacent to `Name`, select `Custom` and enter `Cloze` in the input box.
+7. Make sure that the `Access` field is set to `Mails, Contacts & Calendars`.
+8. Click on `Generate Password` and make a temporary note of it, as it will not be displayed again once you click on `Done`.
+9. Use this password when you add this account in Cloze (Refer to [Linking various Accounts and Services to Cloze](#linking-various-accounts-and-services-to-cloze)).
+
+## Google Sheets API
 
 ### Enable Google Cloud Platform
 
@@ -184,10 +175,3 @@ See [this article for pictures](https://help.cloze.com/help/how-do-i-connect-dro
 3. Share the workbook with the `client_email` address and grant `Edit` permission.
 4. Uncheck `Notify People` since this email address is not handled by a human.
 5. Follow the respective API/library documentation for Google Sheets, for authentication and usage.
-
-## Other Useful Information
-
-### Time Management
-
-- Don't dwell on something too long. Just move to a different project.
-
diff --git a/docs/git-and-github.md b/docs/git-and-github.md
@@ -1,6 +1,6 @@
 # Git and Github
 
-## Edit Notifications for Github
+## Github Notifications
 
 Add your work email address to github so that relevant notifications don't go to your personal inbox:
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,12 +8,42 @@ Welcome to the Nerevu Employee Handbook!
 
 .. toctree::
    :maxdepth: 2
+   :hidden:
 
-   getting-started
+   getting-setup
    recommended-workflow
    git-and-github
    code-style
    new-projects
    resources
-   common-issues
-   finance
+   misc
+
+Your First Week at Nerevu
+-------------------------
+
+Ensure that you complete all of the following
+
+Access your new email account
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`Login to Fastmail <https://www.fastmail.com/login>`_ with the following information:
+
+- username: <YOUR_FIRST_INITIAL><YOUR_LAST_NAME>@nerevu.com, e.g., `rcummings@nerevu.com`
+- password: separately emailed to you
+
+Change your password
+~~~~~~~~~~~~~~~~~~~~
+
+`Instructions <https://www.fastmail.com/help/account/password.html>`_
+
+Complete your Gusto profile
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Follow the instructions contained in the email with the subject `Let's get you set up with Nerevu`.
+
+Complete Paperwork
+~~~~~~~~~~~~~~~~~~
+
+- Sign and return your Employment Agreement
+- `Schedule a time <https://booking.nerevu.com/call-60m>`_ for your orientation and ensure you have your passport (or drivers license and birth certificate) present for the meeting
+- Add a headshot image and a 1 paragraph biography to Dropbox
diff --git a/docs/common-issues.md → docs/misc.md b/docs/common-issues.md → docs/misc.md
@@ -1,5 +1,14 @@
-# Common Issues
+# Misc
 
-## Forgot the Environment File - API Connection Issues
+## Common Issues
+
+### Forgot the Environment File - API Connection Issues
 
 Every project should have a `.env` file associated with it. You can find these files stored [as described here](new-projects#create-an-env-file). If you don't have a `.env` file, you will get confusing errors when trying to connect to an API because you will be missing your `client_id` or other important information. To get the `.env` file in your project, check the [`Nerevu Group Dropbox`](new-projects#create-an-env-file) for one and create a symbolic link to it. If you don't find one in Dropbox, [create one and add it to Dropbox](new-projects#create-an-env-file).
+
+## Retainer Invoicing
+
+- Create a non project linked invoice billed to "Retainer Fees" ([example](https://invoicing.xero.com/view/fa1810de-26a7-476b-b347-da3f9b087132))
+- Create a project linked credit note paid from "Retainer Fees" ([example](https://go.xero.com/AccountsReceivable/ViewCreditNote.aspx?creditNoteID=b9581d93-7e82-41a5-a639-aa30c6e8eecb))
+- Once paid, reconcile the bank transfer
+- Apply credits to future retainer based work
diff --git a/docs/new-projects.md b/docs/new-projects.md
@@ -1,5 +1,7 @@
 # New Projects
 
+## Create a new Project
+
 Start new projects by following the steps in the README of a [Nerevu Cookiecutter](https://github.com/nerevu?q=cookiecutter) repo.
 
 ## ENV file

diff --git a/docs/resources.md b/docs/resources.md
@@ -1,8 +1,9 @@
 # Resources
 
-
 ## Recording Time
 
+- Don't dwell on something too long. Just move to a different task.
+
 ### Timely
 
 * [Getting Started with Timely](https://support.timelyapp.com/en/collections/76502-getting-started)
@@ -18,7 +19,7 @@ When inputting hours worked, tags should be applied to every task we do, whether
 
 *NOTE: When using the `learning` tag, the work is general in nature unrelated to a specific project (e.g., functional programming), please use the `Internal` project. However, if the learning is in relation to a specific project you are working on (e.g., Flask Admin), please use that client project instead of `Internal`.*
 
-## Other
+## ERP
 
 ### Dropbox
 
@@ -32,7 +33,6 @@ When inputting hours worked, tags should be applied to every task we do, whether
 * [API documentation](https://api.cloze.com/api-docs/)
 * [Add GSuite and Dropbox Accounts](https://help.cloze.com/help/how-do-i-connect-dropbox-to-cloze)
 
-
 ### Fastmail
 
 * [Getting Started with Fastmail](https://www.fastmail.com/help/guides/personal.html#gettingstarted)