Skip to content

Commit

Permalink
Migrate to V2 (#167)
Browse files Browse the repository at this point in the history
Co-authored-by: Antonio F. T. <antony@v3x.email>
Co-authored-by: Jonatan <jonatan@jontes.page>
Co-authored-by: Jeff Lau <tyranel@hotmail.com>
Co-authored-by: Andrew Raffensperger <raffy@me.com>
Co-authored-by: Tate <tate@ens.domains>
Co-authored-by: Leon Talbert <leon.talbert@gmail.com>
Co-authored-by: Dimitris Apostolou <dimitris.apostolou@icloud.com>
Co-authored-by: Harry Bairstow <me@harryet.xyz>
Co-authored-by: Jakob Helgesson <jakob.helgesson@gmail.com>
Co-authored-by: Serenae.eth <95138671+serenae-fansubs@users.noreply.github.com>
Co-authored-by: Trees0x <140471239+Trees0x@users.noreply.github.com>
Co-authored-by: Greg <35093316+gskril@users.noreply.github.com>
  • Loading branch information
13 people committed Feb 19, 2024
1 parent 6029f9c commit acf587e
Show file tree
Hide file tree
Showing 531 changed files with 40,720 additions and 315,025 deletions.
Binary file removed .gitbook/assets/ENSGuidelines_01_OnlyDomain_2x.jpg
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed .gitbook/assets/ENSGuidelines_03_Expanded1.jpg
Binary file not shown.
Binary file not shown.
Binary file removed .gitbook/assets/ENS_Map.png
Binary file not shown.
Binary file not shown.
Binary file removed .gitbook/assets/diagram (1).png
Binary file not shown.
Binary file removed .gitbook/assets/diagram.png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_sha (1).png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_sha.png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_step1 (1).png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_step1.png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_step2 (1).png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_step2.png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_step3 (1).png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_step3.png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_step4 (1).png
Binary file not shown.
Binary file removed .gitbook/assets/dnssec_step4.png
Binary file not shown.
Binary file removed .gitbook/assets/ens-architecture (1).png
Binary file not shown.
Binary file removed .gitbook/assets/ens-architecture.png
Binary file not shown.
Binary file removed .gitbook/assets/ensguidelines_01_onlydomain_2x.jpg
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed .gitbook/assets/ensguidelines_03_expanded1.jpg
Binary file not shown.
Diff not rendered.
Binary file removed .gitbook/assets/owasp_w600 (1).png
Diff not rendered.
Binary file removed .gitbook/assets/owasp_w600.png
Diff not rendered.
Diff not rendered.
6 changes: 6 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
@@ -0,0 +1,6 @@
docs/ @lucemans
.github/ @lucemans
app/ @lucemans @svemat01

docs/ensip/ @arachnid
docs/ensip/index @lucemans
24 changes: 24 additions & 0 deletions .github/actions/install/action.yml
@@ -0,0 +1,24 @@
name: Install Tools & Dependencies
description: Installs pnpm, Node.js & package dependencies

runs:
using: composite
steps:
- name: Setup PNPM
uses: pnpm/action-setup@v2.4.0
with:
run_install: false
standalone: true
package_json_file: app/package.json
version: 8

- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 19
cache: pnpm
cache-dependency-path: 'app'

- name: Install dependencies
run: cd app && pnpm install
shell: bash
25 changes: 25 additions & 0 deletions .github/development.md
@@ -0,0 +1,25 @@
# Development Guide

## 🏠 Use node version

Ensure you are on the right version of NodeJS. To see the active version, check [the .nvmrc file](../app/.nvmrc).

```
nvm use
```

## 🏃 Running the project

To run the project, run:

```sh
pnpm dev
```

## 🏗️ Building the project

To build the project, run:

```sh
pnpm build
```
Binary file added .github/readme.png
65 changes: 65 additions & 0 deletions .github/workflows/ci.yml
@@ -0,0 +1,65 @@
name: 🔎

on:
push:
branches: [master,main]
merge_group:
pull_request:
branches: [master,main]

# Automatically cancel in-progress actions on the same branch
concurrency:
group: ${{ github.workflow }}-${{ github.event_name == 'pull_request_target' && github.head_ref || github.ref }}
cancel-in-progress: true

env:
NODE_OPTIONS: "--max_old_space_size=8192"

jobs:
typecheck:
name: 🟦 Typescript
runs-on: ubuntu-20.04
env:
FORCE_COLOR: true
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Install Tools & Dependencies
uses: ./.github/actions/install

- name: Run typecheck
working-directory: ./app
run: pnpm run typecheck
eslint:
name: 👕 Linting
runs-on: ubuntu-20.04
env:
FORCE_COLOR: true
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install Tools & Dependencies
uses: ./.github/actions/install

- name: Run eslint
working-directory: ./app
run: pnpm run lint
build:
name: 🛠️ Build
runs-on: ubuntu-20.04
env:
FORCE_COLOR: true
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install Tools & Dependencies
uses: ./.github/actions/install

- name: Build
working-directory: ./app
run: pnpm run build
64 changes: 64 additions & 0 deletions .github/workflows/deploy.yml
@@ -0,0 +1,64 @@
name: 🚚 Deploy

on:
push:
tags:
- "v[0-9]+.[0-9]+.[0-9]+-?[0-9]+"

env:
NODE_OPTIONS: "--max_old_space_size=8192"

jobs:
deploy:
runs-on: ubuntu-20.04
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Install Tools & Dependencies
uses: ./.github/actions/install

- name: Build
working-directory: ./app
run: pnpm run build
env:
TALLY_API_KEY: ${{ secrets.TALLY_API_KEY }}

- name: Prepare tag
id: prepare_tag
if: startsWith(github.ref, 'refs/tags/')
run: |
TAG_NAME="${GITHUB_REF##refs/tags/}"
echo "::set-output name=tag_name::${TAG_NAME}"
echo "::set-output name=deploy_tag_name::deploy-${TAG_NAME}"
- name: Edgeserver Upload
uses: lvkdotsh/edgeserver-action@v0.1.2-pre.4
with:
app_id: "207908995888658940"
server: https://api.edgeserver.io
token: ${{ secrets.EDGESERVER_TOKEN }}
directory: app/out

- uses: oven-sh/setup-bun@v1

- name: Install dependencies
run: bun install
working-directory: app/scripts
shell: bash

- name: Build search.json
run: bun run build-search
working-directory: app/scripts
shell: bash

- name: Index search.json
shell: bash
run: |
curl --silent -X POST -H "Content-Type: application/json" -H "Authorization: Bearer ${{secrets.SEARCH_TOKEN}}" -d @app/out/search.json https://search.v3x.systems/indexes/ens-docs/documents?primaryKey=id
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,54 @@
# Welcome to ENS docs contributing guide

Thank you for investing your time in contributing to our documentation! Any contribution you make will be reflected on [docs.ens.domains](https://docs.ens.domains) :sparkles:.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

## Getting started

This guide will walk you through the process of contributing to the ENS docs. If you are new to GitHub, you can checkout this [GitHub tutorial](https://guides.github.com/activities/hello-world/) to get started.

### Issues

#### Create a new issue

If you spot a problem with the docs, [search if an issue already exists](https://github.com/ensdomains/docs-v2/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/ensdomains/docs-v2/issues/new).

#### Solve an issue

Scan through our [existing issues](https://github.com/ensdomains/docs-v2/issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don't assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

### Make Changes

#### Make changes in the UI

Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.

#### Make changes locally

1. Fork the repository.

2. (Optional) If you are making any code changes. Install or update to **Node.js**, or run `nvm use` if using [Node Version Manager](https://nvm.sh). For more information, see [the development guide](.github/development.md).

3. Create a working branch and start with your changes!

### Commit your update

Commit the changes once you are happy with them. Upon creating a Pull Request your code will automatically be tested :zap:.

### Pull Request

When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.

### Your PR is merged!

Congratulations :tada::tada: The ENS team thanks you :sparkles:.

Once your PR is merged, your contributions will be publicly visible on the [ENS Docs](https://docs.ens.domains).
121 changes: 121 additions & 0 deletions LICENSE
@@ -0,0 +1,121 @@
Creative Commons Legal Code

CC0 1.0 Universal

CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.

0 comments on commit acf587e

Please sign in to comment.