From e9c85be566c7a340e99e1f9d6f1dfb8b0a94ca92 Mon Sep 17 00:00:00 2001 From: Gareth Coles Date: Tue, 29 May 2018 16:47:52 +0100 Subject: Address input given in contrib channel, and add FAQ --- templates/main/about/channels.html | 6 +- templates/main/info/faq.html | 227 +++++++++++++++++++++++++++++++++++++ templates/main/navigation.html | 6 + 3 files changed, 236 insertions(+), 3 deletions(-) create mode 100644 templates/main/info/faq.html (limited to 'templates') diff --git a/templates/main/about/channels.html b/templates/main/about/channels.html index 0ee8df2f..e970a26d 100644 --- a/templates/main/about/channels.html +++ b/templates/main/about/channels.html @@ -1,7 +1,7 @@ {% extends "main/base.html" %} -{% block title %}Rules{% endblock %} -{% block og_title %}Rules{% endblock %} -{% block og_description %}The server rules, along with an explanation of what happens when they're broken{% endblock %} +{% block title %}Channels{% endblock %} +{% block og_title %}Channels{% endblock %} +{% block og_description %}Channel listing and what's each channel is for{% endblock %} {% block content %}
diff --git a/templates/main/info/faq.html b/templates/main/info/faq.html new file mode 100644 index 00000000..cce9c395 --- /dev/null +++ b/templates/main/info/faq.html @@ -0,0 +1,227 @@ +{% extends "main/base.html" %} +{% block title %}FAQ{% endblock %} +{% block og_title %}FAQ{% endblock %} +{% block og_description %}Frequently Asked Questions{% endblock %} +{% block content %} +
+
+
+

+ Frequently Asked Questions + + + + +

+

+ Insert witty quip here +

+ +
+
+ I'm new to Python - how/where do I get started? +
+
+

+ How you get started with Python is very much going to depend on your prior programming + experience. If you're already an experienced programmer, you should should have no + trouble following pretty much any guide out there - but for true beginners, we recommend + full-on tutorials such as Automate the Boring Stuff with Python. +

+

+ For more information on that and other resources, feel free to take a look at + our resources page. +

+
+ +
+ Should I start with Python 2 or Python 3? Which is better? +
+
+

+ Generally, we're always going to recommend that people new to Python start with Python 3. + There's a few reasons for this: +

+
    +
  • + Python 3 is the latest-and-greatest version. It gets all the new features and is in + active development. +
    • +
  • + Python 2 lacks many features available in Python 3 and is mechanically different in a + few important areas. +
    • +
  • + Python 2 is being sunset and will reach its end of life in 2020. It will not be + maintained past 2020. There will be no Python 2.8. +
    • +
  • + Most libraries now fully support Python 3, and many are dropping or have dropped support + for Python 2. +
    • +
+ +

+ The only reason a user may want to stick with Python 2 is if they are stuck working a job + with a legacy codebase that cannot or will not be updated to work with Python 3. To users + in those situations: Commiserations. +

+
+ +
+ What IDE/Editor should I use? Should I use an IDE if I'm a beginner? +
+
+

+ If you're a beginner, you should not be using an IDE. This is because IDEs do a lot of + basic things automatically where a beginner should learn to do things themselves - for + example, some IDEs can generate huge chunks of code or catch beginner errors without you + even noticing you'd made a typo. +

+

+ If you're not a beginner or you decide to try an IDE regardless, we heavily recommend + PyCharm. This is a well-known IDE which + is entirely in a league of its own, and has a very capable free "community" edition that + will serve most people's needs. +

+

+ We've listed off some of our favourite editors and IDEs on + our resources page. Feel free to + take a look if you're not sure what's out there. +

+

+ By the way, we host quarterly code jams + for the users of our community, and the prize for winning it is a one-year PyCharm Pro + license - sponsored by JetBrains. If you like PyCharm and are thinking of grabbing a copy + of Pro, why not join in? +

+
+ +
+
+ Why can't I import this module? +
+
+

+ When finding yourself unable to import something in Python, you can follow these + steps to figure it out: +

+
    +
  • + Is the module part of Python's standard library? +
    • +
  • + If not, have you installed it? If the module is on PyPi, + you can install it using pip in a terminal: pip install module_name +
    • +
  • + If you think you've installed it, try upgrading it with pip in a terminal: + pip install -U module_name - Make sure there were no errors during + installation +
    • +
  • + If all else fails, make sure you've read the module documentation fully, and ensure + that you're following it correctly +
    • +
  • + If you're sure that you've done everything correctly, you may have found a bug - come + and chat to us, and we might recommend that you report your problem to the developer +
    • +
+
+
+ +
+
+ If I type "python" or "pip" into a terminal, I get "command not found". +
+
+

+ That's not a question, but there's a few things you can look at to try to solve this. +

+
    +
  • + If you're on Windows, the python installer has an option labelled "Add to PATH" - + Make sure you check this when you install python. If you forgot to do that the + first time, then the easiest way to solve this problem is to reinstall Python +
    • +
  • + If you're on Windows, there's a good chance that python and + pip aren't what you actually need to run! Some options you could + try include python3 or python36 - if one of these works, + then you should be able to use pip3 or pip36 as well +
    • +
  • + If you're on a Mac, Python comes with the OS - however, it's quite likely to be + an old version. You can solve this by using Homebrew + to install a more recent version of Python, which should be made available as + python3 +
    • +
+
+
+ +
+
+ What's PEP8? Should I care about code style? +
+
+

+ Python Enhancement Proposal #8 + is known as the official Python style guide. It sets out a lot of very clear guidelines + which help you structure your code. +

+

+ One of the most useful things you can do when writing your code is to follow a style + guide. It makes it easier to read your code overall, but a consistent style guide + is very important as it means that everyone that contributes to your project is + writing code in the same style - meaning everyone will be able to read it. As PEP + itself reads: "A foolish consistency is the hobgoblin of little minds". +

+

+ PEP8 isn't the only style guide available to you, but it is the most widely used + and best-understood of them - and for that reason, we do recommend you use it. That + said, + Google's Python Style Guide + is also widely used by Google engineers. +

+
+
+ +
+
+ Is python a good first language? +
+
+

+ In our opinion, yes it is. It's a very powerful language, but it will force you to + write readable code and it's designed to allow you to write code very quickly, without + you having to keep your head in a book for hours on end. +

+

+ Python is used as a teaching language in many schools, colleges and universities - but + it's a very capable language that is suitable for many real-world tasks as well, and + it's only gaining in popularity! +

+
+
+ +
+
+ What does "real" Python development look like? +
+
+

+ Python is a very versatile language, and a real-life application using it can take + many forms. That said, we do plenty of Python development here ourselves. If + you're curious about this question, then why not take a look at + our projects? +

+
+
+
+ +
+
+
+{% endblock %} diff --git a/templates/main/navigation.html b/templates/main/navigation.html index f1db2a90..f17689be 100644 --- a/templates/main/navigation.html +++ b/templates/main/navigation.html @@ -81,6 +81,12 @@
  • Information
    • {% endif %} + {% if current_page == "main.info.faq" %} +
  • FAQ
    • + {% else %} +
  • FAQ
    • + {% endif %} + {% if current_page == "main.info.help" %}
  • Getting Help
    • {% else %} -- cgit v1.2.3