Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NEPs repo Upgrade 2021-01 #38

Closed
18 tasks done
arisac opened this issue Jan 7, 2021 · 0 comments
Closed
18 tasks done

NEPs repo Upgrade 2021-01 #38

arisac opened this issue Jan 7, 2021 · 0 comments
Assignees

Comments

@arisac
Copy link
Contributor

arisac commented Jan 7, 2021

This issue describes the process NEPs repo will be upgraded and to use with the new NEPs website.

Step 1: Update current NEPs docs:

All changes for Upgrade in main branch from master branch

  1. Move current NEPs files with new Directory Structure in 1 commit with:
    /NEPS/nep-$number.md -> /NEPS/nep-$number/index.md
  2. Move current NEPs' auxiliary files with new Directory Structure in 1 commit with:
    /assets/nep-$number/* -> /NEPS/nep-$number/*
  3. Remove /assets directory in 1 commit
  4. Changing NEPs files with new Front Matter formatting in 1 commit
  5. Update links in NEPs files in 1 commit
  6. Update formatting with Common Mark Specs in 1 commit

Step 2: Initialize NEPs web site configs and files:

All changes for Upgrade in main branch from master branch

  1. Add NewDocs Theme
  2. Add NEPs Website Configs and custom codes
  3. Add Github Actions for Format Check, Build Test and Deploy
  4. Update README file and other necessary files
  5. Deploy on test site

Step 3: Launch new NEPs Website

All changes in this step in pre-launch branch from main branch

  1. Update Deploy script for official domain name and create a PR to main
  2. Update DNS record
  3. Update Gitbub NEPs default repo to main
  4. Merge PR
  5. Change Newton Project Website NEP link
  6. Update README and NEP files in master branch with a notice for default branch changed and master branch is archived
  7. All Done. Start using main branch and the website.
arisac added a commit that referenced this issue Jan 11, 2021
/NEPS/nep-$number.md -> /NEPS/nep-$number/index.md

according to #38
arisac added a commit that referenced this issue Jan 11, 2021
/assets/nep-$number/* -> /NEPS/nep-$number/*

according to #38
arisac added a commit that referenced this issue Jan 11, 2021
arisac added a commit that referenced this issue Jan 11, 2021
links to auxiliary files:
../assets/nep-$number/* -> *

links to another NEP:
nep-$number.md -> ../nep-$number/index.md

according to #38
arisac added a commit that referenced this issue Jan 11, 2021
links to auxiliary files:
../assets/nep-$number/* -> *

links to another NEP:
nep-$number.md -> ../nep-$number/index.md

according to #38
arisac added a commit that referenced this issue Jan 11, 2021
arisac added a commit that referenced this issue Jan 11, 2021
arisac added a commit that referenced this issue Jan 11, 2021
Front Matter & Common Mark Specs

according to #38
arisac added a commit that referenced this issue Jan 11, 2021
formatting

according to #38
arisac added a commit that referenced this issue Jan 11, 2021
arisac added a commit that referenced this issue Jan 11, 2021
@arisac arisac changed the title WIP - NEPs repo Upgrade 2021-01 NEPs repo Upgrade 2021-01 Jan 11, 2021
@arisac arisac pinned this issue Jan 11, 2021
@arisac arisac self-assigned this Jan 11, 2021
arisac added a commit that referenced this issue Jan 12, 2021
the default branch changed to `main` after the merge of #39.

`master` branch will be archived and this commit adds message in docs of `master` branch regarding to this change according to #38.
@arisac arisac closed this as completed Jan 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant