Skip to content
This repository has been archived by the owner on Feb 20, 2024. It is now read-only.

Commit

Permalink
Merge branch 'trunk' into trunk
Browse files Browse the repository at this point in the history
  • Loading branch information
XavierChanth authored Jan 20, 2023
2 parents df89016 + 63de8c7 commit 91ef4ab
Show file tree
Hide file tree
Showing 45 changed files with 695 additions and 298 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/CI.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: CI

on:
push:
branches:
- trunk
pull_request:
branches:
- trunk

permissions: # added using https://github.com/step-security/secure-workflows
contents: read

jobs:
ci:
strategy:
matrix:
command: ['build', 'build:staging']
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
- name: setup node
uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
with:
node-version: '16'
- name: clean install
run: npm ci
- name: ${{ matrix.command }}
run: npm run ${{ matrix.command }}
- name: ensure hugo_stats.json populated with > 100 lines
run: |
if [ $(wc -l < ./hugo_stats.json) -gt 100 ]; then
echo "hugo_stats.json populated with > 100 lines"
else
echo "hugo_stats.json not populated with > 100 lines"
exit 1
fi
5 changes: 4 additions & 1 deletion .github/workflows/CheckDeployStaging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@ on:
env:
DEPLOY_URL: "https://dev3.atsign.wtf"

permissions: # added using https://github.com/step-security/secure-workflows
contents: read

jobs:
audit:
if: ${{ github.event_name == 'workflow_dispatch' || (github.event.deployment_status.state == 'success' && github.event.deployment_status.environment == 'gh-pages') }}
runs-on: ubuntu-20.04
steps:
- name: Git checkout
uses: actions/checkout@v3
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0

- uses: ./.github/workflows/LighthouseAudit
with:
Expand Down
11 changes: 7 additions & 4 deletions .github/workflows/DeployProduction.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,24 @@ on:
env:
URL: 'docs.atsign.com'

permissions: # added using https://github.com/step-security/secure-workflows
contents: read

jobs:
deploy:
if: ${{ github.repository == 'atsign-foundation/docs.atsign.com' }}
runs-on: ubuntu-20.04
steps:
- name: Git checkout
uses: actions/checkout@v3
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0

- name: Setup Node
uses: actions/setup-node@v3
uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
with:
node-version: '16'

- name: Cache dependencies
uses: actions/cache@v3
uses: actions/cache@58c146cc91c5b9e778e71775dfe9bf1442ad9a12 # v3.2.3
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
Expand All @@ -36,7 +39,7 @@ jobs:
run: npm run build:production

- name: Deploy Production
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@bd8c6b06eba6b3d25d72b7a1767993c0aeee42e7 # v3.9.2
with:
personal_token: ${{ secrets.MY_GITHUB_TOKEN }}
external_repository: atsign-foundation/docs.atsign.com-prod
Expand Down
14 changes: 8 additions & 6 deletions .github/workflows/DeployStaging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,24 @@ on:
env:
URL: 'dev3.atsign.wtf'

permissions: # added using https://github.com/step-security/secure-workflows
contents: read

jobs:
deploy:
if: ${{ github.repository == 'atsign-foundation/docs.atsign.com' }}
runs-on: ubuntu-20.04
steps:
- name: Git checkout
uses: actions/checkout@v3
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0

- name: Setup Node
uses: actions/setup-node@v3
uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
with:
node-version: '16'

- name: Cache dependencies
uses: actions/cache@v3
uses: actions/cache@58c146cc91c5b9e778e71775dfe9bf1442ad9a12 # v3.2.3
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
Expand All @@ -35,10 +38,9 @@ jobs:
run: npm run build:staging

- name: Deploy Staging
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@bd8c6b06eba6b3d25d72b7a1767993c0aeee42e7 # v3.9.2
with:
personal_token: ${{ secrets.GITHUB_TOKEN }}
personal_token: ${{ secrets.MY_GITHUB_TOKEN }}
publish_dir: ./public
publish_branch: gh-pages
cname: ${{ env.URL }}

2 changes: 1 addition & 1 deletion .github/workflows/LighthouseAudit/action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ runs:
using: composite
steps:
- name: Perform Lighthouse Audit
uses: jakejarvis/lighthouse-action@master
uses: jakejarvis/lighthouse-action@0b636dea27f28abdde0bd63eba7dc7cafc910d35
with:
url: ${{ inputs.url }}

Expand Down
72 changes: 72 additions & 0 deletions .github/workflows/scorecards.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# This workflow uses actions that are not certified by GitHub. They are provided
# by a third-party and are governed by separate terms of service, privacy
# policy, and support documentation.

name: Scorecards supply-chain security
on:
# For Branch-Protection check. Only the default branch is supported. See
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
branch_protection_rule:
# To guarantee Maintained check is occasionally updated. See
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
schedule:
- cron: '22 4 * * 6'
push:
branches: [ "trunk" ]

# Declare default permissions as read only.
permissions: read-all

jobs:
analysis:
name: Scorecards analysis
runs-on: ubuntu-latest
permissions:
# Needed to upload the results to code-scanning dashboard.
security-events: write
# Needed to publish results and get a badge (see publish_results below).
id-token: write
# Uncomment the permissions below if installing in a private repository.
# contents: read
# actions: read

steps:
- name: "Checkout code"
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
with:
persist-credentials: false

- name: "Run analysis"
uses: ossf/scorecard-action@e38b1902ae4f44df626f11ba0734b14fb91f8f86 # v2.1.2
with:
results_file: results.sarif
results_format: sarif
# (Optional) Read-only PAT token. Uncomment the `repo_token` line below if:
# - you want to enable the Branch-Protection check on a *public* repository, or
# - you are installing Scorecards on a *private* repository
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
repo_token: ${{ secrets.SCORECARD_READ_TOKEN }}

# Public repositories:
# - Publish results to OpenSSF REST API for easy access by consumers
# - Allows the repository to include the Scorecard badge.
# - See https://github.com/ossf/scorecard-action#publishing-results.
# For private repositories:
# - `publish_results` will always be set to `false`, regardless
# of the value entered here.
publish_results: true

# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
# format to the repository Actions tab.
- name: "Upload artifact"
uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
with:
name: SARIF file
path: results.sarif
retention-days: 5

# Upload the results to GitHub's code scanning dashboard.
- name: "Upload to code-scanning"
uses: github/codeql-action/upload-sarif@a34ca99b4610d924e04c68db79e503e1f79f9f02 # v2.1.39
with:
sarif_file: results.sarif
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ public/
.DS_Store
.idea/
node_modules/
resources/_gen/
resources/_gen/
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ For small changes, especially documentation, you can simply use the "Edit" butto
to update the Markdown file, and start the
[pull request](https://help.github.com/articles/about-pull-requests/) process.
Use the preview tab in GitHub to make sure that it is properly
formatted before committing.
formatted before committing. Please use conventional commits and follow the semantic PR format as documented
[here](https://github.com/atsign-foundation/.github/blob/trunk/atGitHub.md#semantic-prs).
A pull request will cause integration tests to run automatically, so please review
the results of the pipeline and correct any mistakes that are reported.

If you plan to contribute often or have a larger change to make, it is best to
setup an environment for contribution, which is what the rest of these guidelines
describe.
describe. The atsign-foundation GitHub organization's conventions and configurations are documented
[here](https://github.com/atsign-foundation/.github/blob/trunk/atGitHub.md).

## Development Environment Setup

Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<img width=250px src="https://atsign.dev/assets/img/atPlatform_logo_gray.svg?sanitize=true">

[![GitHub License](https://img.shields.io/badge/license-BSD3-blue.svg)](./LICENSE)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/docs.atsign.com/badge)](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/docs.atsign.com)

# docs.atsign.com

Expand Down
12 changes: 11 additions & 1 deletion assets/scss/codelab/_main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,13 @@ nav.doks-subnavbar, [data-dark-mode] nav.doks-subnavbar {
}

li[completed] {
text-decoration: line-through;
font-style: italic;
}
li[completed]::after {
content: "";
font-style: normal;
color: $primary;
font-weight: 900;
}

li[selected], li[selected] a {
Expand Down Expand Up @@ -116,6 +122,10 @@ nav.doks-subnavbar, [data-dark-mode] nav.doks-subnavbar {

.codelab-drawer .codelab-steps ol {

li[completed]::after {
color: $highlight;
}

li, li a {
color: $gray-300;
}
Expand Down
1 change: 0 additions & 1 deletion config/_default/config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Basic configuration
baseurl: https://atsign.dev/
canonifyURLs: true
disableAliases: true
disableHugoGeneratorInject: true
Expand Down
3 changes: 3 additions & 0 deletions config/_default/params.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
ProductionURLs:
- 'https://docs.atsign.com/'

# Theme Color for Chrome Browser

themeColor: '#fff'
Expand Down
1 change: 1 addition & 0 deletions config/docs/module.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ mounts:
- partials/head/resource-hints.html
- partials/footer/script-footer.html
- index.html
- robots.txt
- _default/list.html
- _default/single.html
- source: layouts
Expand Down
8 changes: 6 additions & 2 deletions content/docs/atplatform/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@ layout: list

title: "The atPlatform" # The title (ON THE PAGE)
lead: | # The lead below the title (ON THE PAGE)
Learn about how we created our shortcodes on the dev site!
The atPlatform is built on the atProtocol, a new open network protocol, together with a robust set of tools and open source SDKs that makes building end-to-end encryption data exchange easy, and can provide:
Enhanced security,
Faster implementation times,
Cost Savings (Operating and Capital Expenses),
Improved latency
description:
| # SEO Description of the page (Shows in google and atsign.dev search)
What is the atPlatform?
The atPlatform is an open-source source solution designed to help developers build end-to-end, cross-platform applications and IoT solutions, with privacy built in.

draft: false # Change this to "true" to hide the page
toc: true # Change this to "false" to hide the table of contents
Expand Down
10 changes: 5 additions & 5 deletions content/docs/atplatform/rootServer/index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
layout: list

title: "Root Server" # The title (ON THE PAGE)
lead: Learn about the root server behind the atPlatform
title: "atDirectory" # The title (ON THE PAGE)
lead: Learn about the atDirectory behind the atPlatform

description: Learn about the atPlatform root server
description: atDirectory is a service that stores the location of the atServer for each atSign as well as the atSign’s public encryption key (previously called the root server).

draft: false # Change this to "true" to hide the page
toc: true # Change this to "false" to hide the table of contents
autolinks: true # Change this to "false" to hide the automatic links below your content
weight: 4 # For list pages, higher is first.
---

atRoot servers are the only centralized part of the atProtocol and are centralized to provide a single namespace and a global dependable platform. No data beyond the atSign and responding authoritative atSecondary server is held on the root servers. This information is considered public and no authentication is required to look up the atSecondary server for a particular atSign.
atDirectories are the only centralized part of the atProtocol and are centralized to provide a single namespace and a global dependable platform. No data beyond the atSign and responding authoritative atServer is held on the atDirecory. This information is considered public and no authentication is required to look up the atServers for a particular atSign.

{{< image class="bg-none" src="findSecondary.png" type="page" >}}

The atRoot servers have been designed to scale to billions of atSigns and handle the request for atSign lookups at near real-time, globally. To achieve this, in-memory databases are utilized and only the absolute minimum of data is stored.
The atDirectory have been designed to scale to billions of atSigns and handle the request for atSign lookups at near real-time, globally. To achieve this, in-memory databases are utilized and only the absolute minimum of data is stored.
8 changes: 4 additions & 4 deletions content/docs/atplatform/secondaryServer/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
layout: list

title: "Secondary Server" # The title (ON THE PAGE)
lead: Learn about the secondary servers on the atPlatform
title: "atServer" # The title (ON THE PAGE)
lead: Learn about the atServers on the atPlatform

description: Learn about atPlatform secondary edge servers
description: Learn about atPlatform servers responsible for answering lookups for specific atSigns.

draft: false # Change this to "true" to hide the page
toc: true # Change this to "false" to hide the table of contents
autolinks: true # Change this to "false" to hide the automatic links below your content
weight: 5 # For list pages, higher is first.
---

atSecondary (personal atSign) servers provide the second tier of the atProtocol architecture and are responsible for answering lookups for specific atSigns. atSecondary servers provide the lookup service for a particular atSign and one name only. This ensures that the atSecondary server will not mix atSign data with any other atSign’s data. This is unlike web servers that can provide service to multiple websites at a time.
atServers (personal atSign) provide the second tier of the atProtocol architecture and are responsible for answering lookups for specific atSigns. atServers provide the lookup service for a particular atSign and one name only. This ensures that the atServer will not mix atSign data with any other atSign’s data. This is unlike web servers that can provide service to multiple websites at a time.

{{< image class="bg-none" src="noRoot.png" type="page" >}}
Loading

0 comments on commit 91ef4ab

Please sign in to comment.