Skip to content

Commit

Permalink
Merge pull request #12 from MetalPay/metal_l2_refs
Browse files Browse the repository at this point in the history
Changes for Metal L2 references
  • Loading branch information
squdgy authored Oct 16, 2024
2 parents 0cc04d7 + 1497741 commit 097fcf4
Show file tree
Hide file tree
Showing 18 changed files with 49 additions and 184 deletions.
15 changes: 2 additions & 13 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,13 +1,2 @@
* @ethereum-optimism/docs-reviewers

# Giving Node Squad review privileges to the following sections
/pages/builders/chain-operators/ @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad
/pages/chain/ @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad
/pages/stack/ @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad

# Giving Marine privileges to review RPC providers and block explorers
/pages/builders/tools/connect/rpc-providers.mdx @ethereum-optimism/docs-reviewers @0xmariniere
/pages/builders/tools/build/block-explorers.mdx @ethereum-optimism/docs-reviewers @0xmariniere

# Giving Binji privileges to review NFT tools
/pages/builders/tools/build/nft-tools.mdx @ethereum-optimism/docs-reviewers @binjix23
# Code reviewers
* @squdgy @paulgnz
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/suggest_attestation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
Before submitting this suggestion, be sure to read the [listing of current attestation apps](https://docs.optimism.io/identity/applications).
Before submitting this suggestion, be sure to read the [listing of current attestation apps](https://docs.metall2.com/identity/applications).
- type: markdown
id: project_info
attributes:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/suggest_faq_item.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
Before submitting this suggestion, be sure to read our expectations for [FAQ content](https://docs.optimism.io/contribute/style-guide#faqs). <br> For an example FAQ guide with question+answer pairs, see [Security Model FAQ](https://docs.optimism.io/security/faq#security-model-faq).
Before submitting this suggestion, be sure to read our expectations for [FAQ content](https://docs.metall2.com/contribute/style-guide#faqs). <br> For an example FAQ guide with question+answer pairs, see [Security Model FAQ](https://docs.metall2.com/security/faq#security-model-faq).
- type: markdown
id: project_info
attributes:
Expand All @@ -26,7 +26,7 @@ body:
id: faq_where_should_it_live
attributes:
label: What page will this FAQ item live?
description: list the page where the FAQ (question + answer) would be most relevant on docs.optimism.io
description: list the page where the FAQ (question + answer) would be most relevant on docs.metall2.com
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/suggest_glossary_term.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
Before suggesting a new glossary term or glossary term update, make sure you've read [glossary page](https://docs.optimism.io/resources/glossary).
Before suggesting a new glossary term or glossary term update, make sure you've read [glossary page](https://docs.metall2.com/resources/glossary).
- type: markdown
attributes:
value: |
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
Before submitting this suggestion, be sure to read our expectations for [troubleshooting content](https://docs.optimism.io/contribute/style-guide#troubleshooting-guides). <br> For an example troubleshooting guide with problem+solution pairs, see [Troubleshooting: L2 Rollup](https://docs.optimism.io/builders/chain-operators/management/troubleshooting).
Before submitting this suggestion, be sure to read our expectations for [troubleshooting content](https://docs.metall2.com/contribute/style-guide#troubleshooting-guides). <br> For an example troubleshooting guide with problem+solution pairs, see [Troubleshooting: L2 Rollup](https://docs.metall2.com/builders/chain-operators/management/troubleshooting).
- type: markdown
id: project_info
attributes:
Expand All @@ -26,7 +26,7 @@ body:
id: troubleshooting_where_should_it_live
attributes:
label: What page will this troubleshooting item live?
description: list the page where the troubleshooting (problem + solution) would be most relevant on docs.optimism.io
description: list the page where the troubleshooting (problem + solution) would be most relevant on docs.metall2.com
validations:
required: true
- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/suggest_tutorial.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
We'll consider [our defined content types](https://docs.optimism.io/contribute/style-guide#content-types/) when reviewing the tutorial, so please take a look there first.
We'll consider [our defined content types](https://docs.metall2.com/contribute/style-guide#content-types/) when reviewing the tutorial, so please take a look there first.
- type: markdown
id: tutorial_info
attributes:
Expand Down Expand Up @@ -46,7 +46,7 @@ body:
id: tutorial_hosted
attributes:
label: Hosted on Optimism.io or hosted elsewhere?
description: Let us know if you want your tutorial to be hosted on the docs.optimism.io website or if it is published elsewhere and you want us to link out to the tutorial
description: Let us know if you want your tutorial to be hosted on the docs.metall2.com website or if it is published elsewhere and you want us to link out to the tutorial
options:
- "Hosted on optimism.io"
- "Hosted elsewhere"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ jobs:
runs-on: ubuntu-latest

steps:
- name: Checkout ethereum-optimism/docs
- name: Checkout MetalPay/metal-l2-docs
uses: actions/checkout@v2
with:
repository: 'ethereum-optimism/docs'
repository: 'MetalPay/metal-l2-docs'
path: 'docs'

- name: Checkout lycheeverse/lychee
Expand Down
124 changes: 0 additions & 124 deletions .github/workflows/tutorials.yml

This file was deleted.

38 changes: 19 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Contributing to Optimism Docs
# Contributing to Metal L2 Docs

Thanks for taking the time to contribute! ❤️

Optimism's documentation is open-source, hosted on GitHub in the `ethereum-optimism/docs` repository which renders on the corresponding official website hosted at [docs.optimism.io](https://docs.optimism.io). This guide will give you an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. Please note that contributions, pull requests, and issues should be written in English at this time. We will be running a dedicated project in the future to add language support to the technical docs, so please reach out via our [developer support channel](https://github.com/ethereum-optimism/developers/) if you are interested in helping with that project.
Metal L2's documentation is open-source, hosted on GitHub in the `MetalPay/metal-l2-docs` repository which renders on the corresponding official website hosted at [docs.metall2.com](https://docs.metall2.com). This guide will give you an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. Please note that contributions, pull requests, and issues should be written in English at this time.

The Optimism Documentation team reviews pull requests and either merges, requests changes, or comments and closes the pull request. You can open a documentation pull request by:
The Metal L2 Documentation team reviews pull requests and either merges, requests changes, or comments and closes the pull request. You can open a documentation pull request by:

- forking the `docs` repository and working locally,
- or, for smaller updates, clicking the `Edit this page` link on the right side of any documentation page to directly edit in GitHub.

Contributing to the Optimism documentation implies 2 steps:
Contributing to the Metal L2 documentation implies 2 steps:

1. Learn how to use [Nextra](#learn-how-to-use-nextra), the tool used to write and generate Optimism's documentation.
1. Learn how to use [Nextra](#learn-how-to-use-nextra), the tool used to write and generate Metal L2's documentation.

2. [Submit a pull request](#send-pull-request) for review.

## Learn How to Use Nextra

Optimism's documentation is built with the React and Markdown-based [Nextra](https://nextra.site/docs) framework. We are using the docs theme (as opposed to the blog theme), which has specialized features.
Metal L2's documentation is built with the React and Markdown-based [Nextra](https://nextra.site/docs) framework. We are using the docs theme (as opposed to the blog theme), which has specialized features.

To start contributing to Optimism's documentation using Nextra, you need to understand the [files and branches architecture](#understand-file-architecture-and-branch-names) and use the proper [syntax to format content](#use-proper-formatting-and-syntax). Additionally, if you want to work locally from a repository fork, you should [set up the Nextra project](#set-up-the-project-and-test-locally) on your machine.
To start contributing to Metal L2's documentation using Nextra, you need to understand the [files and branches architecture](#understand-file-architecture-and-branch-names) and use the proper [syntax to format content](#use-proper-formatting-and-syntax). Additionally, if you want to work locally from a repository fork, you should [set up the Nextra project](#set-up-the-project-and-test-locally) on your machine.

### Understand File Architecture and Branch Names

Optimism's documentation includes two major sections with each section living in a different folder.
Metal L2's documentation includes two major sections with each section living in a different folder.

| Section name | Target content | Folder |
| ------------------| ----------------------------------------------------------------- | ----------------------------- |
Expand All @@ -32,15 +32,15 @@ Optimism's documentation includes two major sections with each section living in

**Warning**
The `public` folder also stores the `robots.txt` and `sitemap.xml` files used for SEO. Please do not modify these pages.
The Optimism Documentation team will modify these pages, when necessary, after your PR is merged.
The Metal L2 Documentation team will modify these pages, when necessary, after your PR is merged.

### Use Proper Formatting and Syntax

Nextra is MDX-based, meaning the content you write is [Markdown](https://daringfireball.net/projects/markdown/syntax) that accepts [React](https://reactjs.org/) components.

The Optimism Documentation team has created a complete style guide for you to make the best out of the various options available:
The Metal L2 Documentation team has created a complete style guide for you to make the best out of the various options available:

[Optimism Documentation Style Guide](/pages/connect/contribute/style-guide.mdx)
[Metal L2 Documentation Style Guide](/pages/connect/contribute/style-guide.mdx)

### Set Up the Project and Test Locally

Expand All @@ -66,32 +66,32 @@ To prevent building issues upstream, you should build the content locally before
- Try another `pnpm dev` and repeat until no issues are reported ("client" and "server compiled successfully").


Your pull request should usually target the `main` branch, though the Optimism Documentation team might sometimes ask you to target another branch.
Your pull request should usually target the `main` branch, though the Metal L2 Documentation team might sometimes ask you to target another branch.

To submit your contribution for review:

1. Create a new [pull request on GitHub](https://github.com/ethereum-optimism/docs/issues/new/choose).
1. Create a new [pull request on GitHub](https://github.com/MetalPay/metal-l2-docs/issues/new/choose).
2. Select a PR type from the list or choose **Open a blank issue** at the bottom of the page.
3. Complete the form as requested. For blank PR issues, please provide a clear title and accurate description/context.
4. Click the "Create pull request"button to create the pull request effectively.

>If your pull request is not ready for review yet, choose the "[Create draft pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)"in the dropdown. The Optimism documentation team will review your pull request only when you mark it as "[Ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)".
>If your pull request is not ready for review yet, choose the "[Create draft pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)"in the dropdown. The Metal L2 documentation team will review your pull request only when you mark it as "[Ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)".
5. Add GitHub labels for the pull request. Add `documentation` to all pull requests in this repo **AND** additional labels based on the type of update or request.
- `tutorial`, `faq`, or `troubleshooting` for specific content types,
- `oracle`, `rpc-provider`, `faucet`, or `attestation` for ecosystem offerings,
- `user feedback` for general feedback about one or more pages, or
- `bug` if something isn't working as expected.
>If label for type of update is not set, the Optimism Documentation team will set or update this for you<br/>
>If label for type of update is not set, the Metal L2 Documentation team will set or update this for you<br/>
**Warning**
Approved pull requests are usually merged immediately into the `main` branch, automatically triggering a deployment on docs.optimism.io. Please add the `flag:merge-pending-release` label if the pull request content should only be released publicly in sync with a product release.
Approved pull requests are usually merged immediately into the `main` branch, automatically triggering a deployment on docs.metall2.com. Please add the `flag:merge-pending-release` label if the pull request content should only be released publicly in sync with a product release.

That's it! 🥳 Once the pull request is [reviewed and approved](#review-and-management-of-pull-requests), the Optimism Documentation team will merge it, and the content will be live on [docs.optimism.io](http://docs.optimism.io) a few minutes later. 🚀
That's it! 🥳 Once the pull request is [reviewed and approved](#review-and-management-of-pull-requests), the Metal L2 Documentation team will merge it, and the content will be live on [docs.metall2.com](http://docs.metall2.com) a few minutes later. 🚀

## Review and Management of Pull Requests

The pull request review process and timeline are based on the availability of the Optimism Documentation team to handle community contributions. The workflow is as follows:
The pull request review process and timeline are based on the availability of the Metal L2 Documentation team to handle community contributions. The workflow is as follows:

1. The pull request is assigned to a member of the Documentation team.
2. At least 1 member of the Documentation team will review the pull request for:
Expand All @@ -101,7 +101,7 @@ The pull request review process and timeline are based on the availability of th
- alignment with the documentation scope.

3. Reviewers will either approve, ask for changes, or reject the pull request.
4. Accepted pull requests will be merged and automatically deployed on [docs.optimism.io](https://docs.optimism.io) a few minutes later.
4. Accepted pull requests will be merged and automatically deployed on [docs.metall2.com](https://docs.metall2.com) a few minutes later.

## Other Ways to Support the Project
All types of contributions are encouraged and valued.
Expand Down
Loading

0 comments on commit 097fcf4

Please sign in to comment.