diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index dec1d28f..b496531b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,6 +11,7 @@ Why are we doing this? What use cases does it support? What is the expected outc ## Checks - [ ] Run `npm run test` locally. +- [ ] Run `npm run -s lint` locally. - [ ] Create a Pull Request (follow the [GitHub flow](https://guides.github.com/introduction/flow/)) and [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)) - [ ] Verify any structural/CSS changes on all screen sizes (if relevant) diff --git a/assets/scss/common/_custom.scss b/assets/scss/common/_custom.scss index 610e66fd..e2ae7c8d 100644 --- a/assets/scss/common/_custom.scss +++ b/assets/scss/common/_custom.scss @@ -11,10 +11,6 @@ Put CSS for custom HTML components here. } } -body { - // line-height: 1.5em; -} - $code-block-bg: #032332; $border-color: #a9b2bc88; $background-color: $edgeneutral-05; @@ -30,14 +26,13 @@ $tab-content-bg: #f5f6f7; .edgeworx-card-container { display: flex; - flex-flow: row wrap; + flex-direction: row; gap: 1.5rem; - justify-content: space-around; + justify-content: center; align-items: stretch; .no-hover-link { - width: 48%; - min-width: 300px; + max-width: 400px; } & .edgeworx-card { @@ -185,7 +180,7 @@ $tab-content-bg: #f5f6f7; padding-top: 2rem; display: grid; grid-auto-flow: row; - gap: 1.5rem; + gap: 2rem; & .link { text-align: left; @@ -198,14 +193,10 @@ $tab-content-bg: #f5f6f7; } } -@media screen and (min-width: 768px) { +@media screen and (max-width: 768px) { .edgeworx-card-container { - grid-auto-flow: column; - - .edgeworx-card { - // TODO: The below is what makes the card on the front page massive. Commenting out to resize card. - // max-width: unset; - } + flex-direction: column; + align-items: center; } .home { diff --git a/assets/scss/layouts/_footer.scss b/assets/scss/layouts/_footer.scss index 46ad669e..009c112c 100644 --- a/assets/scss/layouts/_footer.scss +++ b/assets/scss/layouts/_footer.scss @@ -1,14 +1,13 @@ .footer { border-top: 1px solid hsla(0, 0%, 100%, 0.1); - background-color: #e3e8f1; - padding-top: 4rem; - padding-bottom: 3rem; + background-color: $edgeneutral-1; + padding: 7rem 2.5rem; font-size: 1rem; .footer-layout { padding-right: 8px; padding-left: 8px; - border-top-color: #a9b2bc; + border-top-color: $edgeneutral-2; text-align: center; img { @@ -29,7 +28,7 @@ display: grid; margin-top: 1.5rem; grid-auto-columns: 1fr; - color: #002131; + color: $edgeneutral-6; .footer-navstack { display: -webkit-box; @@ -45,10 +44,9 @@ .footer-head { margin-top: 0; margin-bottom: 8px; - color: $edgeneutral-3; - font-size: 0.85em; - line-height: 1.5; - font-weight: 600; + color: $edgeneutral-4; + font-size: 1.35em; + font-weight: 500; } .footer-navlink { @@ -57,7 +55,7 @@ -ms-grid-row-align: center; align-self: center; font-weight: 400; - font-size: 0.75em; + font-size: 1.13em; color: $edgeneutral-3; &:hover { @@ -71,21 +69,21 @@ .social { display: grid; margin-top: 1rem; - padding-top: 1rem; + padding-top: 4px; padding-bottom: 0; -webkit-box-pack: justify; -webkit-justify-content: space-between; -ms-flex-pack: justify; justify-content: space-between; - -webkit-box-align: center; - -webkit-align-items: center; - -ms-flex-align: center; - align-items: center; + -webkit-box-align: start; + -webkit-align-items: start; + -ms-flex-align: start; + align-items: start; grid-auto-columns: 1fr; gap: 16px; -ms-grid-rows: auto; grid-template-rows: auto; - border-top: 1px solid $edgeneutral-4; + border-top: 1px solid $edgeneutral-2; -webkit-box-orient: vertical; -webkit-box-direction: normal; -webkit-flex-direction: column; @@ -96,30 +94,19 @@ .logo { justify-self: center; - order: -1; } .legal { - color: #002131; - font-size: 0.74em; + color: $edgeneutral-6; + font-size: 0.8em; display: flex; justify-self: center; - } - - .copyright { - color: $edgeneutral-2; - text-align: right; - } - - .legal-links { - display: flex; flex-direction: row; margin-left: 8px; + margin-top: 8px; div { padding-left: 4px; - color: $edgeneutral-3; - font-weight: 600; } } @@ -141,20 +128,45 @@ grid-template-columns: 1fr 1fr 1fr 1fr; -ms-grid-rows: auto; grid-template-rows: auto; - order: -1; - margin-bottom: 16px; opacity: 0.5; + } - .social-link-block { - width: 1.7em; - margin: 4px; - } + .social-link-block { + margin: 4px; + color: $edgeneutral-6; + } + + .copyright { + margin-right: 4px; + } + + .logo-container { + margin-top: 8px; } } } } @media screen and (max-width: 820px) { + .footer { + padding: 3rem; + + .footer-layout { + .footer-nav { + margin: 0; + + .footer-navstack .footer-navlink { + font-size: 1rem; + } + } + } + } + + .logo-container { + padding-top: 24px; + margin-bottom: 12px; + } + .legal { flex-direction: column; } @@ -162,9 +174,6 @@ @media screen and (min-width: 480px) { .footer { - padding-left: 16px; - padding-right: 16px; - .footer-layout { text-align: left; max-width: 1240px; @@ -178,10 +187,13 @@ grid-template-columns: 1fr 1fr 1fr; -ms-grid-rows: auto; grid-template-rows: auto; - color: #002131; + color: $edgeneutral-6; justify-items: start; .footer-navstack { + border-left: 1px solid $edgeneutral-2; + padding-left: 12px; + .footer-navlink { align-self: flex-start; margin-top: 0; @@ -200,12 +212,10 @@ } .logo { - order: unset; justify-self: end; } .social-buttons { - order: unset; margin-bottom: 0; } } @@ -213,12 +223,6 @@ } } -@media screen and (min-width: 1200px) { - .footer-nav { - margin-right: 50%; - } -} - @media screen and (min-width: 1440px) { .footer { font-size: 19px; diff --git a/config/_default/params.toml b/config/_default/params.toml index 4fec5cbe..e22d79ac 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -54,10 +54,11 @@ lqipWidth = "20x" smallLimit = "300" # Footer -footer = "©2023 Edgeworx Inc" +# The below is not in use due to the {{ time.Now.Year }} not working. I will add it directly to docs\layouts\partials\footer\footer.html +footer = "©{{ time.Now.Year }} Edgeworx" # Feed -copyRight = "©2023 Edgeworx Inc" +copyRight = "© {year} Edgeworx" # Alert alert = false diff --git a/content/en/_index.md b/content/en/_index.md index 5f6eb839..0a128837 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -7,18 +7,25 @@ aliases: - /edgeworx/contact-us cards: - - title: Get started - Edgeworx Cloud Portal - subtitle: Create your Edgeworx Cloud account. - action: Build + - title: Get started, set up your first edge project. + subtitle: Create your Edgeworx Cloud account and your first project. + action: Create project time: Easy - link: '/docs/guides/start-portal/' - image: /images/guides/guide-thumb-deploy.jpg + link: '/docs/cloud/start-portal/' + image: /images/guides/Guide—thumb-create-account.jpg - - title: Deploy an app to the edge in under 10 minutes - subtitle: Package and deploy your app in the real world on different edge devices without changing the code. - action: Deploy + - title: Add an edge node in under 10 minutes. + subtitle: Add a node (or virtual node) to the edge in just a few minutes. + action: Add a node time: Easy - link: '/docs/guides/deploy/' - image: /images/guides/guide-thumb-deploy.jpg + link: '/docs/cloud/adding-nodes/add-node/' + image: /images/guides/Guide—thumb-addnode.jpg + + - title: Deploy an app to the edge in under 10 minutes. + subtitle: Package your app and deploy it to your edge node. + action: Deploy an app + time: Easy + link: '/docs/apps/deploy/' + image: /images/guides/Guide—thumb-deployapp.jpg --- diff --git a/content/en/docs/apps/_index.md b/content/en/docs/apps/_index.md index 79ee03d8..fa9889d3 100644 --- a/content/en/docs/apps/_index.md +++ b/content/en/docs/apps/_index.md @@ -5,7 +5,7 @@ linkTitle: "Building edge apps" --- [Apps](../more/terminology#application) are groups of [microservices](./microservices.md) bundled to work together. They are defined using YAML files and can -be deployed and updated by uploading those YAML files through [Edgeworx Cloud](/docs/guides/start-portal) or through +be deployed and updated by uploading those YAML files through [Edgeworx Cloud](/docs/cloud/start-portal) or through [edgectl]({{}}). An app can consist of an arbitrary number of interacting or standalone microservices that are deployed on one or may nodes. @@ -14,7 +14,7 @@ the Edgeworx Cloud platform to connect to one or more edge nodes. Apps are defin and can be deployed and updated by uploading those YAML files. Edgeworx nodes can be set up to interact with applications, process information, and move data between multiple apps. -![Application view in the Edgeworx Cloud platform]() +![Application view in the Edgeworx Cloud platform]() ## Application Components diff --git a/content/en/docs/apps/demo-apps/heart-rate.md b/content/en/docs/apps/demo-apps/heart-rate.md index 12e5a104..eff3f4b7 100644 --- a/content/en/docs/apps/demo-apps/heart-rate.md +++ b/content/en/docs/apps/demo-apps/heart-rate.md @@ -7,7 +7,7 @@ aliases: ![Heart Rate Demo App](/images/15done.png) -The Heart Rate app provided on the [Edgeworx Cloud](docs/guides/start-portal) platform simulates a wearable device +The Heart Rate app provided on the [Edgeworx Cloud](docs/cloud/start-portal) platform simulates a wearable device transmitting a person's heartbeat at the edge. The Wearable sends heart rate data over bluetooth to a data collector [microservice](/docs/apps/microservices) located on the primary [node](../../cloud/adding-nodes/_index.md). The Data collector microservice then communicates with another microservice running a web server on the secondary node to display the @@ -37,7 +37,7 @@ follow the steps below: 5. Select the node(s) where you want it to run 6. Click `DEPLOY` -![Application Deployment Page](/images/12done.png) +![Application Deployment Page](/images/heart_rate_app_modal.png) ## See Application Results @@ -47,12 +47,12 @@ right of your screen. If you are not already seeing the app listed, click the `APPS` tab to see all of the apps in your current project. Click the app to access the app detail view. -![Project Details View](/images/13done.png) +![Project Details View](/images/deployed_app.png) From the app detail view, click the linked text under the `ports` column to navigate to the app output. -![Application Detail View](/images/14done.png) +![Application Detail View](/images/app_details.png) You should be brought to the Heart Rate Demo App. @@ -81,7 +81,7 @@ spec: data_label: Anonymous Person - name: viewer agent: - name: virtual-node-alexpc + name: nodename images: arm: 'edgeworx/heart-rate-demo-viewer:1.0.0' x86: 'edgeworx/heart-rate-demo-viewer:1.0.0' diff --git a/content/en/docs/guides/deploy.md b/content/en/docs/apps/deploy.md similarity index 91% rename from content/en/docs/guides/deploy.md rename to content/en/docs/apps/deploy.md index 655fb31f..1b20c494 100644 --- a/content/en/docs/guides/deploy.md +++ b/content/en/docs/apps/deploy.md @@ -4,7 +4,7 @@ linkTitle: "Deploy to the edge" weight: 250 --- -![Edgeworx CLoud Project Page](/images/guide4-deploy-cloud.jpg) +![Edgeworx CLoud Project Page](/images/project_view.png) ## What you will accomplish @@ -37,7 +37,7 @@ from Docker after following those steps. ### Add your devices to Edgeworx Cloud -[Edgeworx Cloud](/docs/guides/start-portal) gives you management of all your [edge devices](/docs/cloud/adding-nodes) and [edge applications](/docs/more/terminology/#application) in one place. +[Edgeworx Cloud](/docs/cloud/start-portal) gives you management of all your [edge devices](/docs/cloud/adding-nodes) and [edge applications](/docs/more/terminology/#application) in one place. You can open a SSH shell session on demand, deploy applications, and see the health and status for every device. All of this functionality works no matter where your edge devices are physically located, even when they are behind NAT layers and firewalls. @@ -48,7 +48,7 @@ at [https://cloud.edgeworx.io](https://cloud.edgeworx.io). Once you are in your Edgeworx Cloud account, choose your Sandbox or a [project](/docs/more/terminology#project) nested in an Org, and [add your device as a node](/docs/cloud/adding-nodes/add-node.md) using the `+ ADD NODE` button. Follow the instructions in the pop-up window to continue with either a virtual node or physical device. -![Cloud Portal Plus Button](/images/guides/deploy-node-ui.gif) +![Cloud Portal Plus Button](/images/project_empty.png) ### Create your application YAML @@ -94,11 +94,11 @@ in the steps above. Now that you have all of the pieces, it's easy to deploy your application to your device. In the project where the target device is located, open the `APPS` tab and click `+ DEPLOY APP` and follow the instructions in the pop up. -![Deploy app animation](/images/guides/deploy-app-ui.gif) +![Deploy app animation](/images/app_select.png) In the pop-up window, choose the `UPLOAD YOUR APP` option and you can drag and drop your YAML file into that window or upload it. -![Deploy App](/images/guides/deployAnApp.PNG) +![Deploy App](/images/app_details.png) Edgeworx Cloud will notify you if there are issues with the YAML file or your app deployment. Once deployed, you can monitor the image or images being pulled and their status once it is running. diff --git a/content/en/docs/apps/docker-to-edgeworx.md b/content/en/docs/apps/docker-to-edgeworx.md index be87a7c5..e818f542 100644 --- a/content/en/docs/apps/docker-to-edgeworx.md +++ b/content/en/docs/apps/docker-to-edgeworx.md @@ -8,7 +8,7 @@ aliases: There are several possible [docker run](https://docs.docker.com/engine/reference/commandline/run/) command line options that can be used when spinning up a Docker container. The following docker run commands can -be directly mapped from a `docker run` command to a [Edgeworx Cloud](/docs/guides/start-portal) YAML configuration file: +be directly mapped from a `docker run` command to a [Edgeworx Cloud](/docs/cloud/start-portal) YAML configuration file: 1. Volumes 2. Environment Variables diff --git a/content/en/docs/apps/microservices.md b/content/en/docs/apps/microservices.md index a70affe7..dc96b8a9 100644 --- a/content/en/docs/apps/microservices.md +++ b/content/en/docs/apps/microservices.md @@ -23,7 +23,7 @@ smaller pieces. Key characteristics of microservices: This definition encapsulate the logic we encourage you to use when deploying edge applications on your [nodes](../cloud/adding-nodes/_index.md). But we would add a couple of points to really -nail the [Edgeworx Cloud](/docs/guides/start-portal) Application +nail the [Edgeworx Cloud](/docs/cloud/start-portal) Application Microservice: - It is a [docker container](https://www.docker.com/resources/what-container) that runs on your node diff --git a/content/en/docs/apps/registries.md b/content/en/docs/apps/registries.md index 3da0c952..48828f8c 100644 --- a/content/en/docs/apps/registries.md +++ b/content/en/docs/apps/registries.md @@ -5,7 +5,7 @@ aliases: - /edgeworx/edgeworx-cloud/applications-doc/registries --- -When configuring an [Edgeworx Cloud](/docs/guides/start-portal) [application](../more/terminology#application) YAML file, it is necessary to specify the registry of +When configuring an [Edgeworx Cloud](/docs/cloud/start-portal) [application](../more/terminology#application) YAML file, it is necessary to specify the registry of each [microservice](./microservices.md) container image. The field for this specification is `spec.microservices.image.registry`, and the registry tells the [node](../cloud/adding-nodes/_index.md) the microservice is being deployed to how to access the image container. diff --git a/content/en/docs/apps/yaml-definition.md b/content/en/docs/apps/yaml-definition.md index ca5c2197..67dff4f1 100644 --- a/content/en/docs/apps/yaml-definition.md +++ b/content/en/docs/apps/yaml-definition.md @@ -6,7 +6,7 @@ aliases: - /docs/cloud/portal/ai-explorer-app/app-yaml/ --- -[Edgeworx Cloud](/docs/guides/start-portal) uses [Eclipse ioFog](https://iofog.org) under the covers to deploy and manage +[Edgeworx Cloud](/docs/cloud/start-portal) uses [Eclipse ioFog](https://iofog.org) under the covers to deploy and manage [applications](../more/terminology#application), and all Edgeworx applications are deployed to edge [node(s)](../cloud/adding-nodes/_index.md) via a YAML configuration file. We directly use the ioFog YAML specifications for defining different resource `Kinds`. For diff --git a/content/en/docs/cloud/_index.md b/content/en/docs/cloud/_index.md index f3319dc9..5237fa26 100644 --- a/content/en/docs/cloud/_index.md +++ b/content/en/docs/cloud/_index.md @@ -33,7 +33,7 @@ thoughtful REST APIs and opinionated (and extensible) YAML specs for software de integration with today’s most popular developer tools and workflows. If you know how to use Terraform or Kubernetes then you'll be immediately at home with Edgeworx Cloud. -![Projects Overview](/images/portal-projects-overivew-luckyspin.jpg) +![Projects Overview](/images/project_view_remote.png) ### Features diff --git a/content/en/docs/cloud/access-tokens.md b/content/en/docs/cloud/access-tokens.md index 2311a0c3..82f6e1c7 100644 --- a/content/en/docs/cloud/access-tokens.md +++ b/content/en/docs/cloud/access-tokens.md @@ -24,7 +24,7 @@ https://@api.edgeworx.io/v1/... ```text window.fetch( - "https://api.edgeworx.io/v1/account/cypress%40edgeworx.io", + "https://api.edgeworx.io/v1/account/penny.lim@edge-ample.io", { headers: { Authorization: "Basic " + window.btoa(":")} } @@ -43,14 +43,14 @@ edgectl --token account get Personal Access Tokens have the same privilege as the user they represent and have a lifecycle connected to the user account. -![Personal Access Tokens]() +![Personal Access Tokens]() ### Project Access Token [Project](../more/terminology#project) Access Tokens have full access to the project they represent and have a lifecycle connected to their project. Those are the token used in the [node register script](../more/terminology#node-install-script). -![Project Access Token]() +![Project Access Token]() ### Third Party Access Tokens diff --git a/content/en/docs/cloud/adding-nodes/_index.md b/content/en/docs/cloud/adding-nodes/_index.md index 0cfd7b50..51fea349 100644 --- a/content/en/docs/cloud/adding-nodes/_index.md +++ b/content/en/docs/cloud/adding-nodes/_index.md @@ -12,7 +12,7 @@ Edge devices are the final point of contact for data from the cloud to the end user. An edge node is a physical device with a Linux or equivalent operating system that can serve data to an end user from the edge. -In [Edgeworx Cloud](/docs/guides/start-portal), nodes are edge devices that run Edgeworx Agents. Ultimately, we want to deploy +In [Edgeworx Cloud](/docs/cloud/start-portal), nodes are edge devices that run Edgeworx Agents. Ultimately, we want to deploy apps to these nodes to put them to work. ## AI performance diff --git a/content/en/docs/cloud/adding-nodes/add-node.md b/content/en/docs/cloud/adding-nodes/add-node.md index 7fd56a71..a4a0f90b 100644 --- a/content/en/docs/cloud/adding-nodes/add-node.md +++ b/content/en/docs/cloud/adding-nodes/add-node.md @@ -18,16 +18,16 @@ Add nodes using the Edgeworx Portal UI or terminal commands via [edgectl](../edg Log into [Edgeworx Cloud](https://cloud.edgeworx.io) and select the project you want to [add the node](../../more/terminology#node-register-script). -![Add Node](/images/add-node.png) +![Add Node](/images/project_view_empty_sandbox.png) Click the `+ ADD NODE` button. This will bring up a modal dialog which shows all the types of nodes you could add in your project. -![Register Node Script](/images/select-node-type.png) +![Register Node Script](/images/node_modal.png) Click on `EDGE NODE`. This will bring up a modal dialog which shows the one line command that must be run on your host for it to become a node in your edge project. -![Register Node Script](/images/add-edge-node.png) +![Register Node Script](/images/node_modal_script.png) Click the `COPY` button to copy the install command to your clipboard. @@ -40,7 +40,7 @@ The entire install process can take up to a few minutes (depending on the spec of your node, your internet connection speed, and other dependencies). -![Install Node](/images/edge-node-added.png) +![Install Node](/images/node_script_terminal.png) {{}} If you would like to choose a specific name for your node, use the @@ -53,7 +53,7 @@ as in the example below. Switch back to your project and if you have not done so yet, click the `DONE` button in the modal dialog. You should see your new node `ONLINE` in your nodes list. -![Node Added](/images/1st-node-added.png) +![Node Added](/images/project_view_sandbox_firstnode.png) ## Add a node using edgectl @@ -89,43 +89,43 @@ This is helpful if you wish to review or debug the installation procedure. As the register script runs, you will see it's progress as it install dependencies. ```bash -pi@raspberrypi:~ $ curl -s https://ecj_vfsdasdasdxaeaeh2kskkv301e9f0ip@api.edgeworx.io/v1/project/b7asdasdas-e3f-4808-a992-0811e077d783/node-register-script | sudo bash +pi@raspberrypi:~ $ curl -s https://ecj_usert0ken@api.edgeworx.io/v1/project/pr0jectuuid/node-register-script | sudo bash Installing Edgeworx Agent １ Initializing ✔ Package manager updated ２ Performing preflight checks ▶ Checking for dependencies ✔ curl found - ✔ jq found - ✔ java found - ✔ docker found + ✘ jq not found + ✘ java not found + ✘ docker not found + ▶ Installing dependencies: jq + ✔ jq installed ３ Verifying node state - ✔ Detected Linux distribution: debian - ! Adding this node to a new project will leave a dangling node in the old project: neil/proj1/raspberrypi14511447b32329f25b77. - ! Make sure to migrate any microservices that were running on it, then delete it. E.g. `edgectl node remove neil/proj1/raspberrypi14511447b32329f25b77` - ✔ Node name raspberrypie1c0fe7939883f228946 is valid - ✔ Node name raspberrypie1c0fe7939883f228946 is available + ✔ Detected Linux distribution: ubuntu + ✔ Node name myfirstnode265dedacfa9961ab3b2a is valid + ✔ Node name myfirstnode265dedacfa9961ab3b2a is available ✔ Node is ready for installation ４ System finger print ▶ Shell ∙ Exec: /bin/bash ∙ User: root ▶ Host - ∙ Hostname: raspberrypi - ∙ OS Release: Debian GNU/Linux 11 (bullseye) - ∙ Kernel: Linux raspberrypi 5.10.94-v8+ #1518 SMP PREEMPT Thu Jan 27 14:55:19 GMT 2022 aarch64 GNU/Linux + ∙ Hostname: MyFirstNode + ∙ OS Release: Ubuntu 22.04.3 LTS + ∙ Kernel: Linux MyFirstNode 5.15.0-87-generic #97-Ubuntu SMP Mon Oct 2 21:09:21 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux ▶ System - ∙ CPUs: 4 - ∙ Memory: 5.5Gi - ∙ Storage: 9.5G/118G (9%) + ∙ CPUs: 1 + ∙ Memory: 130Mi + ∙ Storage: 1.7G/4.7G (35%) ５ Installing services - ▶ Edgeworx agent - ✔ Edgeworx Cloud Node created + ▶ Edgeworx Agent + ✔ Node registered with Edgeworx Cloud ✔ GPG found ✔ Edgeworx Agent installed ▶ Deviceplane ✔ Deviceplane Agent registered - ✔ Deviceplane Agent configured + ✔ Deviceplane Agent installed ▶ ioFog Agent ✔ Scripts downloaded ✔ Ready to install @@ -135,7 +135,7 @@ Installing Edgeworx Agent ✔ ioFog Agent registered ✔ ioFog Agent provisioned ６ SUCCESS - ✔ You can view this Agent in your Edgeworx Cloud project here: https://cloud.edgeworx.io/alice/edge-project-1/node/raspberrypie1c0fe7939883f228946 + ✔ You can view this Agent in your Edgeworx Cloud project here: https://cloud.darcy.ai/pennylim/sandbox/node/myfirstnode265dedacfa9961ab3b2a ✔ To uninstall, execute `sudo /opt/edgeworx/uninstall.sh` ``` diff --git a/content/en/docs/cloud/adding-nodes/virtual-node.md b/content/en/docs/cloud/adding-nodes/virtual-node.md index f9f452cf..40a222b2 100644 --- a/content/en/docs/cloud/adding-nodes/virtual-node.md +++ b/content/en/docs/cloud/adding-nodes/virtual-node.md @@ -28,16 +28,16 @@ You can still build locally using attached video and deploy to edge devices with Log into [Edgeworx Cloud](https://cloud.edgeworx.io) and select the project to which you want to add the node. -![Add Virtual Node](/images/add-node.png) +![Add Virtual Node](/images/project_view_empty_sandbox.png) Click the `+ ADD NODE` button. This will bring up a modal dialog which shows the different types of nodes you can add to your project. -![Portal: Select Virtual Node](/images/select-virtual-node.png) +![Portal: Select Virtual Node](/images/node_modal.png) Choose `VIRTUAL NODE` to get the instructions for adding a virtual node. -![Virtual Node Script](/images/add-virtual-node.png) +![Virtual Node Script](/images/node_modal_vn_script.png) Make sure you have the latest versions of [edgectl]({{}}) and [Multipass](https://multipass.run) installed. Click the `COPY` button to copy the command to @@ -50,7 +50,7 @@ Paste the command line that you copied in the previous step into your local term process can take up to a few minutes (depending on the spec of your machine, your internet connection speed, and other dependencies). -![Install Node](/images/virtual-node-added.png) +![Install Node](/images/virtual_node_script_terminal.png) {{}} If you would like to choose a specific name for your node, update the `--name="your-choice-of-name"` in the _edgectl create virtual-node_ command as seen in the above @@ -62,7 +62,7 @@ Switch back to Edgeworx Cloud in your browser and if you have not done so yet, c in the modal dialog. You should see your new node `ONLINE` in your Nodes list. If you do not see your node online, see troubleshooting (below) for more information. -![Node Added](/images/virtual-node-portal-view.png) +![Node Added](/images/project_view_sandbox_vn.png) You now have an edge node, let's start using it! @@ -92,6 +92,9 @@ You can use Multipass' flags in edgectl to control the amount of memory, CPU cor We recommend using `edgectl delete virtual-node` command to delete the Virtual Node after use, so that all the resources used are cleaned up properly i.e. Ubuntu VM. +{{}} Deleting Virtual Nodes in the Portal will require you delete the virtual machines manually where ever they are hosted. Using `edgectl delete virtual-node ` or `multipass delete ` on the host machine will delete the virtual machine. +{{}} + ## Troubleshooting
diff --git a/content/en/docs/cloud/deploy-an-app.md b/content/en/docs/cloud/deploy-an-app.md index 6c821928..e4653a9e 100644 --- a/content/en/docs/cloud/deploy-an-app.md +++ b/content/en/docs/cloud/deploy-an-app.md @@ -10,7 +10,7 @@ Deploy apps using the Edgeworx Portal UI or terminal commands via [edgectl](../c #### Prerequisites -To deploy your custom app, you will need a [Edgeworx Cloud](/docs/guides/start-portal) account with at least one [node](../cloud/adding-nodes/_index.md) accessible +To deploy your custom app, you will need a [Edgeworx Cloud](/docs/cloud/start-portal) account with at least one [node](../cloud/adding-nodes/_index.md) accessible and `ONLINE`. You will need a basic understanding of [how to structure app YAML]({{}}) for Edgeworx Cloud. @@ -21,13 +21,13 @@ of [how to structure app YAML]({{}}) for Ed 3. Click on `+ DEPLOY APP` 4. Drag n' drop a [YAML file]({{}}) into the box -![Application Deployment Page](/images/cloud-deploy-demo.png) +![Application Deployment Page](/images/app_select.png) ### View your Application Details Click on your app in the list of [applications](../more/terminology#application) to see its details. -![Application Detail View](/images/18done.png) +![Application Detail View](/images/app_details.png) The app details page contains information about its [microservices](../apps/microservices.md), routes, the nodes involved in running the microservices and its YAML Definition. @@ -80,7 +80,7 @@ e.g. `edgectl get app edgeworx-heart-rate --json`: (output abbreviated for clari "id": 1, "isActivated": true, "name": "edgeworx-heart-rate", - "projectUUID": "b75676cb-ae3f-4808-a992-0811e077d783", + "projectUUID": "pr0jectuuid", "routes": [ { "from": "monitor", @@ -98,8 +98,8 @@ Use `edgectl get microservices`: ```bash $ edgectl get microservices --app edgeworx-heart-rate NAME STATUS IMAGE NODE -monitor RUNNING edgeworx/healthcare-heart-rate:arm-v1 raspberrypie1c0fe7939883f228946 -viewer RUNNING edgeworx/healthcare-heart-rate-ui-arm:1.0.0 raspberrypie1c0fe7939883f228946 +monitor RUNNING edgeworx/healthcare-heart-rate:arm-v1 west-sf-rnd2346fadc292082f70ed0 +viewer RUNNING edgeworx/healthcare-heart-rate-ui-arm:1.0.0 west-sf-rnd2346fadc292082f70ed0 ``` To view the details of the `monitor` microservice in the `edgeworx-heart-rate` app: diff --git a/content/en/docs/cloud/edgectl/_index.md b/content/en/docs/cloud/edgectl/_index.md index 70f8091f..445b44d5 100644 --- a/content/en/docs/cloud/edgectl/_index.md +++ b/content/en/docs/cloud/edgectl/_index.md @@ -11,7 +11,7 @@ aliases: --- -_edgectl_ is [Edgeworx Cloud's](/docs/guides/start-portal) command line interface (CLI). It can be used to manage Edgeworx +_edgectl_ is [Edgeworx Cloud's](/docs/cloud/start-portal) command line interface (CLI). It can be used to manage Edgeworx Cloud [accounts, organizations,](/docs/more/terminology/#account--org) [projects](/docs/more/terminology#project), [nodes](/docs/cloud/adding-nodes), and [applications](/docs/more/terminology#application). @@ -22,7 +22,7 @@ deploy some live [microservices](/docs/apps/microservices) to the edge. ## Create a Edgeworx Cloud Account Before installing and using _edgectl_, we must first create an account -via [Edgeworx Cloud Portal](https://cloud.Edgeworx.io) (see [docs](/docs/guides/start-portal)). +via [Edgeworx Cloud Portal](https://cloud.Edgeworx.io) (see [docs](/docs/cloud/start-portal)). Navigate to [Cloud Portal](https://cloud.Edgeworx.io) and click the `Create Account` button in the top right. diff --git a/content/en/docs/cloud/node-remote-access.md b/content/en/docs/cloud/node-remote-access.md index 30e786e7..decd091a 100644 --- a/content/en/docs/cloud/node-remote-access.md +++ b/content/en/docs/cloud/node-remote-access.md @@ -3,7 +3,7 @@ title: "Remotely access your node" weight: 700 --- -Once your [node](../cloud/adding-nodes/_index.md) is installed and connected to [Edgeworx Cloud](/docs/guides/start-portal), you'll be able to remotely access it using +Once your [node](../cloud/adding-nodes/_index.md) is installed and connected to [Edgeworx Cloud](/docs/cloud/start-portal), you'll be able to remotely access it using the Edgeworx Cloud portal and/or [edgectl]({{}}). ## Prerequisites @@ -15,12 +15,12 @@ and `ONLINE` and some knowledge of `SSH` commands. In the portal, click on any node to access the node's detail page. -![Node Detail Page](/images/7done.png) +![Node Detail Page](/images/app_details_empty.png) From here, click on the `SSH` button. This will open a new tab in your browser, after a small loading time, you'll have access to a terminal on your node. -![SSH Terminal Page]() +![SSH Terminal Page]() {{}}You can also access the SSH shortcut from the [project](/docs/more/terminology#project) overview page by clicking the 3 dots to the right of your node and selecting `SSH` from the drop down menu. diff --git a/content/en/docs/cloud/orgs-and-members.md b/content/en/docs/cloud/orgs-and-members.md index 04362b54..19b69cf4 100644 --- a/content/en/docs/cloud/orgs-and-members.md +++ b/content/en/docs/cloud/orgs-and-members.md @@ -30,9 +30,9 @@ you first sign up). You will then be guided through creation. The only required ![Org Create Screen](/images/orgs/org-create.png) -![Org Create Details Screen](/images/orgs/org-create-details.png) +![Org Create Details Screen](/images/create_org_modal.png) -![Org Details Screen](/images/orgs/org-details.png) +![Org Details Screen](/images/dashboard_org_details.png) ## Invite members @@ -62,11 +62,7 @@ members into the org by email. ![Org Member Invite Screen](/images/orgs/org-member-invite.png) If you need to invite more members, you can do so through the member details screen. -Navigate to the org page, and click invite to invite a new member by their email. - -![Org Details Screen](/images/orgs/org-details.png) - -![Org Member Invite Screen](/images/orgs/org-member-invite.png) +Navigate to the org page, and click `INVITE MEMBER` to invite a new member by their email. ## Accept invite @@ -104,7 +100,7 @@ UUID NAME PERSONAL ORG CREATED UTC SCOPES You should receive an email with directions on how to accept an org invite. Follow the instructions to create an account and accept the invite to the new org. -![Org Member Invite Email](/images/orgs/org-member-invite-email.png) +![Org Member Invite Email](/images/verification_email.png) ## Modify member scopes @@ -123,9 +119,9 @@ Updated scopes on account {bob} in org {15e23cf5-c4f7-4ac9-aedb-689231124f10|acm In the Cloud Portal, navigate to the org page, click the settings wheel next to the "members" header, and select the permission you want to change for a user. -![Org Member Details](/images/orgs/org-member-details.png) +![Org Member Details](/images/org_details_members.png) -![Change Member Permissions](/images/orgs/org-member-change-permissions.png) +![Change Member Permissions](/images/org_details_members_perm.png) ## Remove member @@ -143,6 +139,4 @@ edgectl delete member --org acme --account bob In the Cloud Portal, navigate to the org page, click the settings wheel next to the "members" header, and remove the user with the "delete" icon next to the user's email. -![Org Member Details](/images/orgs/org-member-details.png) - -![Remove Member](/images/orgs/org-member-remove.png) +![Remove Member](/images/org_member_delete_modal.png) diff --git a/content/en/docs/guides/start-portal.md b/content/en/docs/cloud/start-portal.md similarity index 66% rename from content/en/docs/guides/start-portal.md rename to content/en/docs/cloud/start-portal.md index 25bb28c7..ebd1135e 100644 --- a/content/en/docs/guides/start-portal.md +++ b/content/en/docs/cloud/start-portal.md @@ -12,33 +12,35 @@ Navigate to [Edgeworx Cloud](https://cloud.edgeworx.io/welcome) using your brows and Safari preferred- other browsers are not thoroughly maintained) and click the `Create Account` button. -![Edgeworx Cloud Welcome Page](/images/cloud-home.png) +![Edgeworx Cloud Welcome Page](/images/splash_page.png) Enter your unique username and click `NEXT`. -![Create Account]() +![Create Account]() On the "Welcome" page, choose an auth provider or provide your own email and password. Edgeworx Cloud uses Auth0 to provide secure account creation and access. -![Create Account Auth0]() - -![Verify Email]() +![Create Account Auth0]() ## Verify Your Email -You may need to check your spam folders. The email sender will be `no-reply@auth0user.net`. +You may need to check your spam folders. The email sender will be `support@edgeworx.io`. + +![Verify Email]() + +![Verify Email]() -![Email Verified]() +![Email Verified]() -## View Your Edgeworx Cloud edge project +## View Your Edgeworx Cloud project Once your account has been created, you can spin up a personal Sandbox or a fully featured 30-day free trial Org. -![Your Project is Being Created]() +![Your Project is Being Created]() Once your edge project is created, you will see your project overview page and be able to [add your first node!](/docs/cloud/adding-nodes). -![Project Overview](/images/1done.png). +![Project Overview](/images/sandbox.png) diff --git a/content/en/docs/guides/_index.md b/content/en/docs/guides/_index.md deleted file mode 100644 index 3ce81d77..00000000 --- a/content/en/docs/guides/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Guides" -weight: 300 -linkTitle: "Guides" -toc: false -cards: - - - title: Get started - Edgeworx Cloud Portal - subtitle: Create your Edgeworx Cloud account. - action: Build - time: Easy - link: '/docs/guides/start-portal/' - image: /images/guides/guide-thumb-deploy.jpg - - - title: Deploy an app to the edge in under 10 minutes - subtitle: Package and deploy your app in the real world on different edge devices without changing the code. - action: Deploy - time: Easy - link: '/docs/guides/deploy/' - image: /images/guides/guide-thumb-deploy.jpg ---- -{{< cards >}} diff --git a/layouts/index.html b/layouts/index.html index 059201cc..e8ea0d56 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -38,7 +38,7 @@

Start Here

What is Edgeworx Cloud?

-
Edgeworx Map
+
Edgeworx Map
Edgeworx Cloud is a platform for deploying and managing edge apps and devices
Build apps in your local environment, deploy them to the edge to Linux devices, and run everything from anywhere using Edgeworx Cloud.
diff --git a/layouts/partials/footer/footer.html b/layouts/partials/footer/footer.html index 6b5b7a88..c94d1bd6 100644 --- a/layouts/partials/footer/footer.html +++ b/layouts/partials/footer/footer.html @@ -1,47 +1,45 @@