-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Restructure tutorial to separate instructions based on operating system #1796
Open
amakarudze
wants to merge
18
commits into
DjangoGirls:restructure-tutorial
Choose a base branch
from
amakarudze:change-structure-1792
base: restructure-tutorial
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
564152a
Switch to actions/deploy-pages
ekohl 39b7faa
Merge pull request #1791 from ekohl/remove-need-for-gh-pages-branch
amakarudze 00446f4
Split setup instructions and summary
amakarudze ab0d913
Restructure content by OS, refactor installation steps
amakarudze fdbbb86
Remove unnecessary files from Chromebook folder
amakarudze 91ee4c3
Fix Python installation and introduction sections
amakarudze db9e969
Fix django installation instructions
amakarudze efe896a
Restruture content up to Python introduction
amakarudze 8fc2734
Refactor deploy folder, delete reduntant folders
amakarudze 5368e73
Fix line breaks at 80 for chromebook/README.md
amakarudze 11488b4
Fix lines for chromebook/django_start_project/README.md
amakarudze 0c3e2d7
Fix line length for macosx/django_start_project/README.md
amakarudze 808a0fd
Fix runcode file line length
amakarudze b3f114c
Fix line length for windows and runcode
amakarudze 7bd90b9
Fix lines for code editor folder
amakarudze dcde212
Fix line length for more files
amakarudze 3dd54d8
Fix link for runcode django_start_project
amakarudze 213850f
Fix navigation issues, refactor SUMMARY.md
amakarudze File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,47 @@ | ||
--- | ||
name: Build and Deploy | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
build-and-deploy: | ||
build: | ||
runs-on: ubuntu-latest | ||
if: github.repository == 'djangogirls/tutorial' | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
uses: actions/checkout@v3 | ||
with: | ||
persist-credentials: false | ||
|
||
- name: Install and Build | ||
run: | | ||
npm install | ||
npx honkit build | ||
|
||
- name: Deploy | ||
uses: JamesIves/github-pages-deploy-action@releases/v3 | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v1 | ||
with: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
BRANCH: gh-pages | ||
FOLDER: _book | ||
path: _book | ||
|
||
deploy: | ||
needs: build | ||
permissions: | ||
pages: write | ||
id-token: write | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,28 +2,82 @@ | |
|
||
* [Introduction](README.md) | ||
* [Installation](installation/README.md) | ||
* [Installation (RunCode Cloud)](cloud_development_setup/README.md) | ||
* [Installation (Chromebook)](chromebook_setup/README.md) | ||
* [Installation (OS X/Windows/Linux)](installation/README.md#osx-windows-linux) | ||
* [Command Line](installation/README.md#intro-command-line) | ||
* [Python](installation/README.md#python) | ||
* [Code Editor](installation/README.md#code-editor) | ||
* [Virtual Environment](installation/README.md#virtualenv) | ||
* [Django](installation/README.md#django) | ||
* [Git](installation/README.md#git) | ||
* [GitHub](installation/README.md#github-account) | ||
* [PythonAnywhere](installation/README.md#pythonanywhere-account) | ||
* [RunCode Cloud Installation](runcode/README.md) | ||
* [GitHub](runcode/README.md#github) | ||
* [RunCode](runcode/README.md#runcode) | ||
* [Visual Studio Code](runcode/README.md#visual-studio-runcode) | ||
* [PythonAnywhere](runcode/README.md#pythonanywhere) | ||
* [Command Line](runcode/README.md#command-line) | ||
* [Django](runcode/README.md#django) | ||
* [ChromeBook Installation](chromebook/README.md) | ||
* [Cloud IDE](chromebook/README.md#cloud-ide) | ||
* [PaizaCloud Cloud IDE](chromebook/README.md#paizacloud-cloud-ide) | ||
* [AWS Cloud9](chromebook/README.md#aws-cloud9) | ||
* [Glitch.com Cloud IDE](chromebook/README.md#glitch-cloud-ide) | ||
* [Virtual Environment](chromebook/README.md#virtual-environment) | ||
* [GitHub](chromebook/README.md#github) | ||
* [Linux Installation](linux/README.md) | ||
* [Command Line](linux/README.md#intro-command-line) | ||
* [Python](linux/README.md#python) | ||
* [Code Editor](linux/README.md#code-editor) | ||
* [Virtual Environment](linux/README.md#virtualenv) | ||
* [Django](linux/README.md#django) | ||
* [Git](linux/README.md#git) | ||
* [GitHub](linux/README.md#github-account) | ||
* [Mac OSX Installation](macosx/README.md) | ||
* [Command Line](macosx/README.md#intro-command-line) | ||
* [Python](macosx/README.md#python) | ||
* [Code Editor](macosx/README.md#code-editor) | ||
* [Virtual Environment](macosx/README.md#virtualenv) | ||
* [Django](macosx/README.md#django) | ||
* [Git](macosx/README.md#git) | ||
* [GitHub](macosx/README.md#github-account) | ||
* [PythonAnywhere](macosx/README.md#pythonanywhere) | ||
* [Windows Installation](windows/README.md) | ||
* [Command Line](windows/README.md#intro-command-line) | ||
* [Python](windows/README.md#python) | ||
* [Code Editor](windows/README.md#code-editor) | ||
* [Virtual Environment](windows/README.md#virtualenv) | ||
* [Django](windows/README.md#django) | ||
* [Git](windows/README.md#git) | ||
* [GitHub](windows/README.md#github-account) | ||
* [PythonAnywhere](windows/README.md#pythonanywhere-account) | ||
* [How the Internet works](how_the_internet_works/README.md) | ||
* [Introduction to command line](intro_to_command_line/README.md) | ||
* [Python installation](python_installation/README.md) | ||
* [Code editor](code_editor/README.md) | ||
* [RunCode- Introduction to command line](runcode/intro_to_command_line/README.md) | ||
* [ChromeBook/Linux- Introduction to command line](linux/intro_to_command_line/README.md) | ||
* [Mac OSX - Introduction to command line](macosx/intro_to_command_line/README.md) | ||
* [Windows - Introduction to command line](windows/intro_to_command_line/README.md) | ||
* [Python Installation](python_installation/README.md) | ||
* [ChromeBook/Linux - Python installation](linux/python_installation/README.md) | ||
* [Mac OSX - Python installation](macosx/python_installation/README.md) | ||
* [Windows - Python installation](windows/python_installation/README.md) | ||
* [Introduction to Python](python_introduction/README.md) | ||
* [RunCode - Introduction to Python](runcode/python_introduction/README.md) | ||
* [Linux - Introduction to Python](linux/python_introduction/README.md) | ||
* [Mac OSX - Introduction to Python](macosx/python_introduction/README.md) | ||
* [Windows - Introduction to Python](windows/python_introduction/README.md) | ||
* [Code editor](code_editor/README.md) | ||
* [What is Django?](django/README.md) | ||
* [Django installation](django_installation/README.md) | ||
* [Django Installation](django_installation/README.md) | ||
* [RunCode - Django installation](runcode/django_installation/README.md) | ||
* [ChromeBook - Django installation](chromebook/README.md#glitch-cloud-ide) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Here it points to the section, not README.MD, is it supposed to be? |
||
* [Linux - Django installation](linux/django_installation/README.md) | ||
* [Mac OSX - Django installation](macosx/django_installation/README.md) | ||
* [Windows - Django installation](windows/django_installation/README.md) | ||
* [Your first Django project!](django_start_project/README.md) | ||
* [RunCode - Your first Django project!](runcode/django_start_project/README.md) | ||
* [ChromeBook - Your first Django project!](chromebook/django_start_project/README.md) | ||
* [Linux - Your first Django project!](linux/django_start_project/README.md) | ||
* [Mac OSX - Your first Django project!](macosx/django_start_project/README.md) | ||
* [Windows - Your first Django project!](windows/django_start_project/README.md) | ||
* [Django models](django_models/README.md) | ||
* [Django admin](django_admin/README.md) | ||
* [Deploy!](deploy/README.md) | ||
* [RunCode - Deploy!](runcode/deploy/README.md) | ||
* [Linux - Deploy!](linux/deploy/README.md) | ||
* [Mac OSX - Deploy!](macosx/deploy/README.md) | ||
* [Windows - Deploy!](windows/deploy/README.md) | ||
* [Django URLs](django_urls/README.md) | ||
* [Django views – time to create!](django_views/README.md) | ||
* [Introduction to HTML](html/README.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to do those changes with this PR? 🤔
Otherwise, I would do them separately, just so we can make it slightly smaller 😅