Skip to content

Commit

Permalink
Update existing Get started articles (#1728)
Browse files Browse the repository at this point in the history
* Update existing Get started articles

* Fix navigation
  • Loading branch information
simplykatsa authored Dec 3, 2024
1 parent 2f1b367 commit cd170bf
Show file tree
Hide file tree
Showing 8 changed files with 80 additions and 62 deletions.
Binary file added app/assets/images/get-started/authorize.png
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.
Binary file added app/assets/images/get-started/instance-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added app/assets/images/get-started/new-instance.png
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.
51 changes: 32 additions & 19 deletions app/views/pages/get-started/installation-and-configuration.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -6,60 +6,73 @@ converter: markdown
---


There are three key steps for starting development on platformOS:
- [signing up on the Partner Portal](#sign-up-on-partner-portal),
- [creating an instance](#create-an-instance)
- [installing the platformOS command line interface](#install-pos-cli).
There are three key steps for starting development on platformOS:
- [Signing up on the Partner Portal](#sign-up-on-partner-portal)
- [Creating an instance](#create-an-instance)
- [Installing the platformOS command-line interface](#install-pos-cli)


## Sign up on the Partner Portal

The [Partner Portal](https://partners.platform-os.com/) is an online interface, where you can create, manage, and configure your sites.
The [Partner Portal](https://partners.platform-os.com/) is an online interface where you can create, manage, and configure your sites.

<img loading="lazy" class="w-full" src="{{ 'images/get-started/partner-portal-list.png' | asset_url }}" alt="Screenshot of the Partner Portal">

To interact with platformOS you will need to have an account, so the very first thing you need to do is [register on the Partner Portal](https://partners.platformos.com/accounts/sign_up).

Make sure that you’ll verify your account by following the instructions you’ll find in the email we send you after the registration.
Make sure to verify your account by following the instructions in the email we send you after registration.


## Create an instance
In order to begin working with platformOS, you need to create an instance where you will be running your code and storing files.{% include 'alert/tip', content: 'Each separate site that you can create in the Partner Portal is called an **instance**.' %}

In order to create a new instance you need to be logged in the [Partner Portal](https://partners.platformos.com/) and in the left navigation you’ll find a [Create Instance](https://partners.platformos.com/instances/new) link.
To start working with platformOS, you need to create an instance where you’ll run your code and store files.

{% include 'alert/tip', content: 'Each separate site that you can create in the Partner Portal is called an **instance**.' %}

To create a new instance, log in to the [Partner Portal](https://partners.platformos.com/). By default, you will see your list of instances after logging in. Click on the [New Instance](https://partners.platformos.com/instances/new) button above the instances list.

<img loading="lazy" class="w-full" src="{{ 'images/get-started/new-instance.png' | asset_url }}" alt="Screenshot of the Instances list on the Partner Portal, highlighting the New Instance button">

The _Instance name_ can be any name of your choice. The only other options you’ll need to choose are the _Data Center_ and _Billing plan_. For the needs of this guide we can use the _Staging_ environment, which is a **completely free** environment designed for testing and developement.
The _Instance name_ can be any name of your choice. The other options you’ll need to select are the _Data Center_ and _Billing plan_. For this scenario, use the _Staging_ environment, which is a **completely free** environment designed for testing and development.

Choosing the _Staging_ data center and clicking on the _Staging Unbilled_ plan should be enough for you to create your first instance.
Select the _Staging_ data center and choose the _Staging Unbilled_ plan to create your first instance.

On the list of instances, you may initially see your instance marked with the _SCHEDULED_TO_ACTIVATE_ status. This process usually takes only a couple of seconds.
<img loading="lazy" class="w-full" src="{{ 'images/get-started/create-new-instance.png' | asset_url }}" alt="Screenshot of a properly filled New Instance form">

After a short while, you should see the status changed to _Active_ when you refresh the page. This means that you can go to the instance URL visible in the list and check if it's working. This URL is important: you’ll see all the code changes here.
In the list of instances, your instance may initially be marked with the _SCHEDULED_TO_ACTIVATE_ status. This process usually only takes a few seconds.

After a short while, refresh the page, and the status should change to _Active_. This means you can visit the instance URL listed and check if it’s working. This URL is important, as you’ll see all your code changes reflected here.


## Install pos-cli

The platformOS command line interface – or `pos-cli` – is a tool that will allow you to interact with your instance.
The platformOS command line interface – or `pos-cli` – is a tool that allows you to interact with your instance.

The `pos-cli` offers a variety of options that you can explore later in this guide or directly in the [pos-cli documentation](/developer-guide/pos-cli/pos-cli).

The pos-cli offers a variety of options that you can explore in later sections of this guide, or you can jump right in to the [pos-cli documentation](/developer-guide/pos-cli/pos-cli).
{% include 'alert/tutorial', content: 'For detailed usage instructions and advanced options, make sure to read the <a href="https://github.com/Platform-OS/pos-cli?tab=readme-ov-file#overview"_blank">README of the pos-cli on GitHub</a>.' %}

**To install the pos-cli** you’ll need a recent version of NPM (Node Package Manager) installed on your system. NPM is distributed with Node.js, so we recommend you follow the [official guide for installing Node.js and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). If you get lost there, it might be the easiest to use the [node.js installer](https://nodejs.org/en/download/) that will look just like installing any other program on your system.
To install `pos-cli`, you need a recent version of NPM (Node Package Manager) installed on your system. NPM is distributed with Node.js, so we recommend following the[official guide for installing Node.js and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). If you get lost there, the easiest way is to use the [Node.js installer](https://nodejs.org/en/download/), which functions like any other program installer.

Once you have Node.js installed, start your command-line tool of choice and run the following:<pre class="command-line" data-user="user" data-host="host"><code class="language-bash">
Once Node.js is installed, open your command-line tool of choice and run:

<pre class="command-line" data-user="user" data-host="host"><code class="language-bash">
npm install -g @platformos/pos-cli
</code></pre>

The `-g` attribute means you are installing the tool globally. That might require having higher system permissions. On unix-based systems that means using sudo and on Windows it might require running your command-line tool with the administrative rights (it should be available in the right-click context menu).
The `-g` attribute installs the tool globally, which may require higher system permissions. On Unix-based systems, use `sudo`, and on Windows, you may need to run the command-line tool as an administrator (this option is available in the right-click context menu).

<pre class="command-line" data-user="user" data-host="host"><code class="language-bash">
sudo npm install -g @platformos/pos-cli
</code></pre>

After installing the pos-cli you should be able to test if everything ran successfully with the following command:
After installing `pos-cli`, verify the installation by running the following command:

<pre class="command-line" data-user="user" data-host="host"><code class="language-bash">
pos-cli -v
</code></pre>

If everything went smoothly, the version number of the pos-cli tool that you’ve just installed is displayed (for example: `4.7.1`).
If everything was installed successfully, you’ll see the version number of the `pos-cli` tool displayed (for example, `4.7.1`).


{% render 'alert/next', content: 'Working with the code and files', url: '/get-started/working-with-the-code-and-files/' %}
Loading

0 comments on commit cd170bf

Please sign in to comment.