Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,36 @@ git submodule update --init

## Update the Golioth Docs submodule

When updates are made to the Golioth Docs repo, the can be pulled into this one by updating the submodule:
When updates are made to the Golioth Docs repo, they can be pulled into this one by updating the submodule to the tip of its default branch (`main`):

```console
git submodule foreach git pull
git submodule update --remote --merge
```

This leaves the updated submodule pointer staged, so commit it to record the update:

```console
git add submodule-goliothdocs
git commit -m "Update Golioth Docs submodule"
```

> **Note:** Don't use `git submodule foreach git pull`. Submodules are checked out in a detached-HEAD state, so a plain `git pull` has no branch to track and fails with *"You are not currently on a branch."*

## Testing and Deploying

The Docusaurus site lives in the `website/` directory, so run all npm commands from there.

Docs pages can be tested locally:

```bash
cd website
npm install
npm start
```

Docs can be deployed to the live page by running:

```bash
cd website
npm run deploy
```
2 changes: 1 addition & 1 deletion submodule-goliothdocs
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ This section guides you through the Golioth account creation process. You need
an account in order to generate credentials so your device can authenticate with
Golioth.

With the Golioth Dev tier, your first 50 devices are free. There is a 'wizard'
that will guide you through creating your first device on the platform.
All Golioth accounts get $50 in free credits each month. See our [pricing page](https://golioth.io/pricing) to
understand how we charge, but a single device (or a small fleet!) will have a hard
time using all of that credit in a single month. There is a 'wizard' that will
guide you through creating your first device on the platform.

* **Desired outcome(s)**
1. Understand how to add a single device to the console
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import FlexImage from '@site/src/components/FlexImage';
import GoliothConsoleOnboarding from './assets/console/console-onboarding.png';
import GoliothConsoleVerifyEmail from './assets/console/console-verify-email.png';

import GoliothWizard1 from './assets/console/console-quickstart-step1-wizard.png';
import GoliothProjectCreate from './assets/console/console-quickstart-step1-createproject.png';

import GoliothWizard2 from './assets/console/console-quickstart-step2-wizard.png';
import GoliothCreateDevice from './assets/console/console-quickstart-step2-createdevice.png';

## Creating your Golioth account

To begin using Golioth please register for an account at
[console.golioth.io](https://console.golioth.io/). Click "Sign up" to register
a new account with a email/password or a Google SSO account.

![Golioth Console Registration](./assets/console/register_new_golioth_account.png)

### Answering Questions, Verifying Email

<FlexImage column_count="2">
<img src={GoliothConsoleOnboarding} alt="Golioth console sign-up questions"/>
<img src={GoliothConsoleVerifyEmail} alt="Golioth console verify email"/>
</FlexImage>

Once registered, you will be asked some onboarding questions and to review our
terms of service. You will need to verify your email address to continue. If
you don't see the email (from Auth0) within 5 minutes tell an instructor or
if you are taking this training asynchronously, email support@golioth.io

## Creating a new Project

<FlexImage column_count="2">
<img src={GoliothWizard1} alt="Golioth console add project wizard"/>
<img src={GoliothProjectCreate} alt="Golioth console create a project"/>
</FlexImage>

### Project name

Golioth organizes fleets into "Projects". When first logging into Golioth you
will be directed to create a project using the `Create` button in the upper
right. You may use the auto-generated project name, or create your own. Project
names cannot be changed after creation so pick a good one!

## Creating a new Device

<FlexImage column_count="3">
<img src={GoliothWizard2} alt="Golioth console wizard create a device"/>
<img src={GoliothCreateDevice} alt="Golioth console device creation dialog"/>
</FlexImage>

### Device name

Each project is made up of a number of devices. The next step will direct you to
create a device using the `Create` button in the upper right. Once again you may
use the auto-generated device name or create your own. Device names may be
changed at any time.

### Tags and Hardware IDs

Tags and Hardware IDs are a great tool for organizing your growing fleet. For
now we'll leave these blank.

### Device credentials

In our new flow, you can choose to user our certificate generator or to
choose a Pre-Shared Key (PSK) credential. The former is the more secure, but
for on-boarding, we choose PSK-ID and PSK for simplicity. These are the
credentials that will authenticate this device to the Golioth Cloud.


![New device summary window](./assets/console/gettingstarted-console-createdevice-confirmation.png)

## That's it!

It really is that simple, you have provisioned your first device! Let's
look at what we just created.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Let's use the Golioth Console to view our existing devices, which should only be
the device you just created.

![Golioth Console device view](./assets/console/gettingstarted-console-devices.png)

In the center at the top of the console window the currently selected project is
shown. On the left sidebar we can use the Devices option to list this project's
devices. Here we see the device that was created by the quickstart wizard.



## New device summary

Clicking on your device, you can check out the "detail view" of your new device record

![New device summary window](./assets/console/detail-view-summary.png)



## Retrieving Device Credentials

To access device credentials, select the Credentials tab from the device view
in the Golioth Console. The PSK-ID and PSK (the Identity and the Pre Shared
Key) are what your device needs to authenticate and connect to the Golioth
Cloud. You can always return to this panel in the device details to retrieve
these values.

![Device details now includes device credentials](./assets/console/detail-view-creds.png)


Congratulations, you're ready to move on to selecting hardware!
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 45 additions & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const darkCodeTheme = themes.dracula;
const config = {
title: 'Developer Training',
tagline: 'Learn about Golioth and Zephyr, with hands-on exercises',
url: 'https://golioth.github.io',
url: 'https://training.golioth.io',
baseUrl: '/',
trailingSlash: false,
onBrokenLinks: 'throw',
Expand Down Expand Up @@ -38,9 +38,53 @@ const config = {

plugins: [ 'docusaurus-plugin-image-zoom' ],

themes: [
[
require.resolve('@easyops-cn/docusaurus-search-local'),
/** @type {import('@easyops-cn/docusaurus-search-local').PluginOptions} */
({
hashed: true,
indexBlog: false,
docsRouteBasePath: '/',
highlightSearchTermsOnTargetPage: true,
explicitSearchResultPath: true,
}),
],
],

// Structured data so search engines and LLMs can classify the site as a course.
headTags: [
{
tagName: 'script',
attributes: { type: 'application/ld+json' },
innerHTML: JSON.stringify({
'@context': 'https://schema.org',
'@type': 'Course',
name: 'Golioth & Zephyr Developer Training',
description:
'Free, hands-on training for building IoT firmware with Zephyr RTOS and connecting devices to the Golioth cloud.',
provider: {
'@type': 'Organization',
name: 'Golioth',
url: 'https://golioth.io',
},
url: 'https://training.golioth.io',
}),
},
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Default social-card image used for Open Graph / Twitter previews.
image: 'img/Zephyr-Classroom.jpg',
metadata: [
{
name: 'keywords',
content:
'Golioth, Zephyr, Zephyr RTOS, IoT, embedded firmware, nRF9160, nRF7002, LightDB, OTA firmware update, devicetree, Kconfig, west, developer training',
},
],
colorMode: {
defaultMode: 'dark',
respectPrefersColorScheme: false,
Expand Down
Loading