[site/content][s]: rm duplicate howtos
This commit is contained in:
Ola Rubaj
parent
907ef9cbd3
commit
d8dfa8b682
@ -1,37 +0,0 @@
|
||||
---
|
||||
title: How to quickly add a simple Markdown-based page
|
||||
date: 2023-07-27
|
||||
authors: ['Lauren Wigmore', 'Ola Rubaj']
|
||||
filetype: 'blog'
|
||||
---
|
||||
|
||||
Welcome to this howto on how to quickly add a simple Markdown-based page to your website. The steps here are designed for non-technical contributors. There's no need to know how to code!
|
||||
|
||||
> [!important]
|
||||
> This "How to" is only recommended for very simple Markdown pages, e.g. those without images, links to other pages, diagrams, or other elements that can't be previewed in GitHub preview mode.
|
||||
|
||||
> [!tip]
|
||||
> If you are unfamiliar with Markdown (and its different flavours and extra elements supported by Flowershow based websites), check out [this short guide](https://flowershow.app/docs/syntax) on available syntax elements.
|
||||
|
||||
## Steps
|
||||
|
||||
1. Go to the repository of your website in GitHub.
|
||||
2. Click on the `content` folder to open it. This is where all the Markdown files for a Flowershow-based website are stored.
|
||||
3. Optionally, navigate to a subfolder where you want to add your page.
|
||||
4. Click “Add file” and write the page name + extension `.md`, e.g. `my-new-page.md`.
|
||||
|
||||
> [!tip]
|
||||
> If you want to add your page to a new subfolder, in the "Name your file..." field, first type the name of the new subfolder, followed by a forward slash, .e.g., `blog/`. After you hit the slash, you'll see the name field gets cleared, but the path before it has been extended with your subfolder name. You can repeat this process if you want to put your file into further nested subfolders. Then, simply type the name of the file with ".md" extension.
|
||||
|
||||
5. Paste or write the contents of the file in Markdown format.
|
||||
6. (Optionally) Switch to the "Preview" mode, by toggling from "Edit" -> "Preview" at the top of the file content, to see a rough visualisation of your changes. Keep in mind though, that the actual website may have different styling and may support additional Markdown elements that GitHub doesn't render on the preview.
|
||||
7. When you're happy with the content, click on the “Commit changes...” button. In the "Commit message" field, provide a concise summary of your changes. If necessary, you can add further explanation in the "Extended description" text field. Then select “Commit directly to the main branch”, and hit "Commit changes."
|
||||
8. The site is now going to be rebuilt to reflect the changes saved to the `main` branch. This can take up to a few minutes. After this time you should see your page live.
|
||||
|
||||
## Summary
|
||||
|
||||
Congratulations, you've now learned how to create a new Markdown page on your Flowershow-based website.
|
||||
|
||||
If anything is not clear to you, or you have suggestions on how we can make this 'How to' better, please don't hesitate to let us know.
|
||||
|
||||
Happy editing!
|
||||
@ -1,83 +0,0 @@
|
||||
---
|
||||
title: 'How to edit a page with a code editor or Obsidian'
|
||||
date: 2023-07-27
|
||||
authors: ['Jake Hirsch', 'Ola Rubaj']
|
||||
filetype: 'blog'
|
||||
isDraft: true
|
||||
---
|
||||
|
||||
#### Setup
|
||||
|
||||
- Create a [GitHub](https://github.com/) account if you don’t already have one
|
||||
- Download [VS Code](https://code.visualstudio.com/) or [Obsidian](https://obsidian.md/). You can use whichever one you prefer. This is what you’ll use to view and edit the website’s Markdown files.
|
||||
|
||||
#### Key steps
|
||||
|
||||
##### Stage 1: Fork
|
||||
|
||||
In this stage, you ‘fork’ the Life Itself Web3 repository, i.e. you make a remote copy of the repository in your own GitHub account. If you’ve forked the repo before, skip this stage.
|
||||
|
||||
- Go to the repo storing the website content: [https://github.com/life-itself/web3](https://github.com/life-itself/web3) (0:00-0:02)
|
||||
- Click the ‘Fork’ button in the upper right-hand corner of the repo page to fork the repository
|
||||
|
||||
##### Stage 2: Clone
|
||||
|
||||
In this stage, you ‘clone’ your forked repository, i.e. you copy your forked version of the Life Itself Web3 repo to your computer so that you can make edits on your local machine without affecting the remote git repo. 00:40-01:50 of the [video tutorial](https://drive.google.com/file/d/1mWqXDx6ICJ_1qreoYoB774weWi-AtyDo/view) corresponds to this stage. _If you’ve cloned the forked repo before, skip this stage._
|
||||
|
||||
- Search your computer for its ‘terminal’ and open it. The terminal is simply a text-based way of interacting with the computer through commands. In the terminal, you can type commands, manipulate files, execute programs, and open documents. (00:03-00:39)
|
||||
- On your forked repo page (make sure you’re not on the main repo page), click the green ‘Code’ button and copy the HTTPS link
|
||||
- Type into Terminal "cd `directory`", where `directory` is replaced by the path to the folder you want to navigate to. E.g. “cd Desktop/Folder/life_itself/tutorial”. On a Mac, you can drag the folder to the terminal after typing “cd”. Otherwise, you can find the folder path [Mac](https://www.howtogeek.com/721126/3-ways-to-see-the-current-folder-path-on-mac/#:~:text=Open%20a%20Finder%20window%2C%20and,path%20to%20the%20current%20folder.); [Windows](https://www.wikihow.com/Find-a-File%27s-Path-on-Windows) and type or paste it in manually.
|
||||
- What you’re doing here is navigating in Terminal to the folder on your computer where you want to save the cloned repository (i.e. changing the working directory). Normally, on your computer you do this by searching for a folder and clicking on the icon to open it. In Terminal, you do this by typing commands. The command for changing directory is: `directory`. (00:40-1:11)
|
||||
- Type into Terminal the command “git clone” and then paste the repo URL you copied. E.g. “git clone https://github.com/life-itself/web3.git”. Press enter. (1:13-1:48)
|
||||
- N.B. When you try this, you may be prompted to install command line developer tools to be able to run git commands, e.g. XCode for Mac. If this is the case, follow the instructions for installation.
|
||||
|
||||
##### Stage 3: Branch
|
||||
|
||||
In this stage, you create a new ‘branch’, or temporary version, of the repository on which to make edits. These edits will later be merged with the main repository branch.
|
||||
|
||||
- Navigate in Terminal to the Life Itself Web3 repo which has been cloned to your computer. To do this, type "cd web3" or "cd `directory`" (as in Stage 2). Press enter. (1:49-2:02)
|
||||
- Update your local clone of the remote repository. _You don’t need to do this if you’ve only just cloned the repo just now._
|
||||
- Type into Terminal “git pull”. Press enter.
|
||||
- Create a branch on which to make edits
|
||||
- Type "git checkout -b `your_branch_name`". E.g. you might name your branch “edits”. So you would type “git checkout -b edits”. This command will create a new branch and switch you to this branch. N.B. the branch name cannot contain spaces.
|
||||
|
||||
##### Stage 4: Edit
|
||||
|
||||
In this stage, you use either a code editor, such as VS Code (see 4a), or Obsidian (see 4b) to view and edit the website’s Markdown files.
|
||||
|
||||
###### 4a: VS Code
|
||||
|
||||
- Open VS Code
|
||||
- Click the ‘Explorer’ icon at the top left hand side of the window. Then click ‘Open Folder’ to open the Life Itself Web3 repo which you cloned. You will then be able to see the list of folders from the repo on the left side of the window. (2:03-3:35)
|
||||
- Find the file that corresponds with the page you want to edit.\* (3:31-4:03)
|
||||
- Make your edits and save
|
||||
|
||||
###### 4b: Obsidian
|
||||
|
||||
- Open Obsidian
|
||||
- Open the cloned github repo folder as a vault (10:07)
|
||||
- Find the file that corresponds with the page you want to edit.\*
|
||||
- Make your edits and save.
|
||||
- See video tutorial (13:05-15:26) for info on useful Obsidian features such as shortcuts for linking to other pages.
|
||||
|
||||
\*N.B. To find the file that corresponds with the page you want to edit, it might help to look at the page URL. E.g. To find the file containing the “Blockchain” page ([https://web3.lifeitself.us/concepts/blockchain](https://web3.lifeitself.us/concepts/blockchain)), go to the folder “concepts“, then the file “blockchain.md”.
|
||||
|
||||
##### Stage 5: Pull request
|
||||
|
||||
In this stage, you prepare the changes you have made (and saved) to a Markdown file to be published on the website.
|
||||
|
||||
- Go to your computer’s Terminal (4:59-5:08)
|
||||
- Type “git status”. Press enter. (5:09-5:30)
|
||||
- Type "git add `name of modified file`". E.g. “git add site/content/test.md”. Press enter. (5:31-6:06) If you’ve edited more than one file, you can type “git add.” to add all the modified files with one command.
|
||||
- Type "git commit -m “`description of edit`"". E.g. "git commit -m “fix typo”" or "git commit -m “add extra text to definition”". Press enter. Note that the description of the edit must be in double quotation marks. (6:07-7:01)
|
||||
- Type "git push origin `your_branch_name`", replacing `your_branch_name` with the name of the branch you create.
|
||||
- Submit your changes for review: Go to your Github repo and click on the “Compare & pull request” button. Add a description and submit the pull request.
|
||||
- Someone from our team will review and confirm the merge. Once they’ve done that, your edit will appear on the site! Thanks for contributing!
|
||||
|
||||
##### Resolving merge conflicts
|
||||
|
||||
On occasion, it is possible that after submitting a pull request you may get a message flagging merge conflicts. This could be because when you were making your changes, someone else might have pushed new changes to the same content you were editing. If this happens, see here for what to do to [resolve a merge conflict](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line).
|
||||
|
||||
# Contact
|
||||
|
||||
If you run into any issues while following this guide, please [let us know](https://lifeitself.us/contact/) so we can improve this guide to help future contributors.
|
||||
@ -1,67 +0,0 @@
|
||||
---
|
||||
title: How to push an Obsidian vault to a GitHub repository
|
||||
date: 2023-07-27
|
||||
authors: ['Jake Hirsch', 'Ola Rubaj']
|
||||
filetype: 'blog'
|
||||
---
|
||||
|
||||
This howto walks you through the process of setting up your Obsidian vault as a GitHub repository. Here are some of the benefits of doing so:
|
||||
|
||||
1. Creating a backup of your notes, accessible from anywhere.
|
||||
2. Keeping track of your note-taking history, thereby enabling you to see the evolution of your ideas over time.
|
||||
3. Collaborating with others on your notes.
|
||||
|
||||
In this howto, we will use the GitHub Desktop application, an easy-to-use interface for managing your Git repositories locally and on GitHub. This tool is particularly useful if you're not comfortable with Git's command line interface or if you just prefer a more visual representation of your Git operations.
|
||||
|
||||
## Steps
|
||||
|
||||
### Step 1: Setting Up GitHub Desktop App
|
||||
|
||||
1.1. If you haven't already done so, create a GitHub account at https://github.com
|
||||
|
||||
1.2. Download and install the GitHub Desktop app from https://desktop.github.com
|
||||
|
||||
1.3. Once installed, open the GitHub Desktop app. You'll be prompted to sign in with your GitHub account.
|
||||
|
||||
### Step 2: Setting Up Your Vault as a GitHub Repository
|
||||
|
||||
2.1. In the GitHub Desktop app, click on "Add an Existing Repository from your Hard Drive"
|
||||
|
||||
2.2. Navigate to your Obsidian vault's folder using the file explorer.
|
||||
|
||||
2.3. After selecting it, you'll see a warning saying "This directory does not appear to be a Git repository. Would you like to create a repository here instead?" Click on the link "create a repository".
|
||||
|
||||
2.4. You'll be brought to the "Create a New Repository" page with the vault's location already in the "Local Path" box.
|
||||
|
||||
2.5. Choose a name for your repository. It's best to use lowercase and dashes. (For the sake of simplicity use the same or similar name to your vault's folder name.)
|
||||
|
||||
2.6. Add an optional description.
|
||||
|
||||
2.7. Make sure the checkbox "Initialise this repository with a README" is unchecked, and "Git Ignore" and "License" are set to "None".
|
||||
|
||||
2.8. Click on "Create Repository".
|
||||
|
||||
Great! Now you have your Obsidian vault set up as a git repository. Now, let's push it to GitHub.
|
||||
|
||||
### Step 3: Pushing Your Vault to GitHub
|
||||
|
||||
3.1. After you've created the repository, in the GitHub Desktop app you'll see a dashboard with the heading "No local changes". Below you'll see a suggestion with a button "Publish repository". Click on it. (You could also use "Publish repository" button in the top application bar.)
|
||||
|
||||
3.2. A new window will appear. Choose a name (it will automatically suggest the one you chose during the creation process, and its best to leave it this way), add an optional description, and select whether you want it to be public or private.
|
||||
|
||||
> [!Important]
|
||||
> Please be aware that if your GitHub repository is public, this process will make your Obsidian vault publicly accessible. If you wish to keep your vault private, you'll need to select "Private" when publishing the repository.
|
||||
|
||||
3.3. Click on "Publish Repository".
|
||||
|
||||
3.4. Wait for the process to finish. You'll see a small prompt when the upload is complete.
|
||||
|
||||
3.5. You can now visit your repository on GitHub's website to see your uploaded Obsidian vault.
|
||||
|
||||
## Summary
|
||||
|
||||
Congratulations, you've now learned how to push an Obsidian vault to your Github repository.
|
||||
|
||||
If anything is not clear to you, or you have suggestions on how we can make this 'How to' better, please don't hesitate to let us know.
|
||||
|
||||
Happy editing!
|
||||
@ -1,32 +0,0 @@
|
||||
---
|
||||
title: How to quickly create a sandbox website
|
||||
date: 2023-07-27
|
||||
authors: ['Lauren Wigmore', 'Ola Rubaj']
|
||||
filetype: 'blog'
|
||||
---
|
||||
|
||||
By the end of this guide you will have a working markdown site you can edit, which gets published automatically online 🎉
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A GitHub account. If you don’t have one, click [here](https://github.com/signup) to create it.
|
||||
- A Vercel account. If you don't have one, click [here](https://vercel.com/signup) to create it. Ideally, sign up using your Github account or you can choose to sign up with your email.
|
||||
|
||||
## Sandbox setup
|
||||
|
||||
1. Go to https://github.com/datopian/flowershow
|
||||
2. At the bottom of the page there is a "Deploy" button - click on this to be redirected to Vercel and log in using your account.
|
||||
3. Once you have logged in, you will be redirected to the "Create GitHub Repository" page.
|
||||
4. If you've signed up to Vercel with your GitHub account, you'll see "Git scope" and the field for the repo name. But if you've signed up using email, you'll see different buttons, like "GitHub", "Bitbucket", "GitLab". You need to select GitHub and possibly login to your GitHub account.
|
||||
5. Select your GitHub account from the "Git Scope" drop-down. If it's not there, click on "Add GitHub Account" to add it.
|
||||
6. In the right-hand box write a name for the repository. The usual format is all lowercase with hyphens in between words. Then click on the "Create" button.
|
||||
|
||||
The website will then be deployed. This takes approximately 1 minute.
|
||||
|
||||
Once you are on the Congratulations screen, click on the preview of your sandbox website to see the live/published version.
|
||||
|
||||
For instructions on how to add and edit pages, we recommend these howtos:
|
||||
|
||||
- [[howtos/add-a-simple-md-page|add-a-simple-md-page|How to add a simple markdown page]]
|
||||
- [[blog/edit-text-on-a-single-md-page|edit-text-on-a-single-md-page|How to edit text on a single markdown-based page]]
|
||||
- [[blog/edit-or-add-md-pages-locally|edit-or-add-md-pages-locally|How to edit or add a markdown page locally on your computer]]
|
||||
@ -1,13 +1,16 @@
|
||||
---
|
||||
title: How to quickly add a simple Markdown-based page
|
||||
date: 2023-07-27
|
||||
authors: ['Lauren Wigmore', 'Ola Rubaj']
|
||||
filetype: 'blog'
|
||||
---
|
||||
|
||||
Welcome to this tutorial on how to quickly add a simple Markdown-based page to your website. The steps here are designed for non-technical contributors. There's no need to know how to code!
|
||||
Welcome to this howto on how to quickly add a simple Markdown-based page to your website. The steps here are designed for non-technical contributors. There's no need to know how to code!
|
||||
|
||||
> [!important]
|
||||
> This "How to" is only recommended for very simple Markdown pages, e.g. those without images, links to other pages, diagrams, or other elements that can't be previewed in GitHub preview mode.
|
||||
> This "How to" is only recommended for very simple Markdown pages, e.g. those without images, links to other pages, diagrams, or other elements that can't be previewed in GitHub preview mode.
|
||||
|
||||
>[!tip]
|
||||
> [!tip]
|
||||
> If you are unfamiliar with Markdown (and its different flavours and extra elements supported by Flowershow based websites), check out [this short guide](https://flowershow.app/docs/syntax) on available syntax elements.
|
||||
|
||||
## Steps
|
||||
@ -20,15 +23,15 @@ Welcome to this tutorial on how to quickly add a simple Markdown-based page to y
|
||||
> [!tip]
|
||||
> If you want to add your page to a new subfolder, in the "Name your file..." field, first type the name of the new subfolder, followed by a forward slash, .e.g., `blog/`. After you hit the slash, you'll see the name field gets cleared, but the path before it has been extended with your subfolder name. You can repeat this process if you want to put your file into further nested subfolders. Then, simply type the name of the file with ".md" extension.
|
||||
|
||||
5. Paste or write the contents of the file in Markdown format.
|
||||
5. Paste or write the contents of the file in Markdown format.
|
||||
6. (Optionally) Switch to the "Preview" mode, by toggling from "Edit" -> "Preview" at the top of the file content, to see a rough visualisation of your changes. Keep in mind though, that the actual website may have different styling and may support additional Markdown elements that GitHub doesn't render on the preview.
|
||||
5. When you're happy with the content, click on the “Commit changes...” button. In the "Commit message" field, provide a concise summary of your changes. If necessary, you can add further explanation in the "Extended description" text field. Then select “Commit directly to the main branch”, and hit "Commit changes."
|
||||
6. The site is now going to be rebuilt to reflect the changes saved to the `main` branch. This can take up to a few minutes. After this time you should see your page live.
|
||||
7. When you're happy with the content, click on the “Commit changes...” button. In the "Commit message" field, provide a concise summary of your changes. If necessary, you can add further explanation in the "Extended description" text field. Then select “Commit directly to the main branch”, and hit "Commit changes."
|
||||
8. The site is now going to be rebuilt to reflect the changes saved to the `main` branch. This can take up to a few minutes. After this time you should see your page live.
|
||||
|
||||
## Summary
|
||||
|
||||
Congratulations, you've now learned how to create a new Markdown page on your Flowershow-based website.
|
||||
Congratulations, you've now learned how to create a new Markdown page on your Flowershow-based website.
|
||||
|
||||
If anything is not clear to you, or you have suggestions on how we can make this 'How to' better, please don't hesitate to let us know.
|
||||
If anything is not clear to you, or you have suggestions on how we can make this 'How to' better, please don't hesitate to let us know.
|
||||
|
||||
Happy editing!
|
||||
|
||||
@ -1,5 +1,8 @@
|
||||
---
|
||||
title: "How to edit a page with a code editor or Obsidian"
|
||||
title: 'How to edit a page with a code editor or Obsidian'
|
||||
date: 2023-07-27
|
||||
authors: ['Jake Hirsch', 'Ola Rubaj']
|
||||
filetype: 'blog'
|
||||
isDraft: true
|
||||
---
|
||||
|
||||
|
||||
@ -1,5 +1,8 @@
|
||||
---
|
||||
title: How to push an Obsidian vault to a GitHub repository
|
||||
date: 2023-07-27
|
||||
authors: ['Jake Hirsch', 'Ola Rubaj']
|
||||
filetype: 'blog'
|
||||
---
|
||||
|
||||
This howto walks you through the process of setting up your Obsidian vault as a GitHub repository. Here are some of the benefits of doing so:
|
||||
@ -34,7 +37,7 @@ In this howto, we will use the GitHub Desktop application, an easy-to-use interf
|
||||
|
||||
2.6. Add an optional description.
|
||||
|
||||
2.7. Make sure the checkbox "Initialize this repository with a README" is unchecked, and "Git Ignore" and "License" are set to "None".
|
||||
2.7. Make sure the checkbox "Initialise this repository with a README" is unchecked, and "Git Ignore" and "License" are set to "None".
|
||||
|
||||
2.8. Click on "Create Repository".
|
||||
|
||||
|
||||
@ -1,5 +1,8 @@
|
||||
---
|
||||
title: How to quickly create a sandbox website
|
||||
date: 2023-07-27
|
||||
authors: ['Lauren Wigmore', 'Ola Rubaj']
|
||||
filetype: 'blog'
|
||||
---
|
||||
|
||||
By the end of this guide you will have a working markdown site you can edit, which gets published automatically online 🎉
|
||||
@ -22,13 +25,8 @@ The website will then be deployed. This takes approximately 1 minute.
|
||||
|
||||
Once you are on the Congratulations screen, click on the preview of your sandbox website to see the live/published version.
|
||||
|
||||
For instructions on how to add and edit pages, we recommend these tutorials:
|
||||
For instructions on how to add and edit pages, we recommend these howtos:
|
||||
|
||||
- [[edit-a-page-with-code-editor-or-obsidian|How to edit text content on a single Markdown-based page]]
|
||||
- [[add-a-simple-md-page|How to add a simple Markdown-based page]]
|
||||
|
||||
Here are some other links Vercel links that might be useful for you:
|
||||
|
||||
- [Dashboard Features Overview](https://vercel.com/docs/concepts/dashboard-features/overview)
|
||||
- [Dashboard Features](https://vercel.com/docs/concepts/dashboard-features)
|
||||
- [Projects](https://vercel.com/docs/concepts/projects/project-dashboard)
|
||||
- [[howtos/add-a-simple-md-page|add-a-simple-md-page|How to add a simple markdown page]]
|
||||
- [[blog/edit-text-on-a-single-md-page|edit-text-on-a-single-md-page|How to edit text on a single markdown-based page]]
|
||||
- [[blog/edit-or-add-md-pages-locally|edit-or-add-md-pages-locally|How to edit or add a markdown page locally on your computer]]
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user