Skip to content

Commit

Permalink
Documentation consistency (#1082)
Browse files Browse the repository at this point in the history
* Improve documentation consistency: use capitals for acronyms, GitHub instead of github, etc.

* Improve documentation: use quotes for literals like in other places

* Documentation improvements: use https:// for links and avoid trailing slash if linking to the main page

* Improve documentation: update names
  • Loading branch information
cpina committed Nov 14, 2020
1 parent 902467f commit 77af82c
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 39 deletions.
4 changes: 2 additions & 2 deletions docs/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ However, following Section 508 (and the World Wide Web Consortium's (W3C) `Web A

In the meantime, django-crispy-forms provides a means to easily render Section 508 compliant forms. How awesome is that?

.. _`Section 508`: http://en.wikipedia.org/wiki/Section_508
.. _`Web Accessibility Initiative`: http://en.wikipedia.org/wiki/Web_Accessibility_Initiative
.. _`Section 508`: https://en.wikipedia.org/wiki/Section_508
.. _`Web Accessibility Initiative`: https://en.wikipedia.org/wiki/Web_Accessibility_Initiative
20 changes: 10 additions & 10 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Contributing
Setup
=====

Fork on github
Fork on GitHub
--------------

Before you do anything else, login/signup on Github.com and fork django-crispy-forms from https://github.com/django-crispy-forms/django-crispy-forms.
Before you do anything else, login/signup on GitHub.com and fork django-crispy-forms from https://github.com/django-crispy-forms/django-crispy-forms.

Clone your fork locally
-----------------------

If you have git-scm installed, you now clone your git repo using the following command-line argument where <my-github-name> is your account name on github::
If you have git-scm installed, you now clone your git repository using the following command-line argument where <my-github-name> is your account name on GitHub::

git clone git@github.com/<my-github-name>/django-crispy-forms.git

Expand All @@ -35,7 +35,7 @@ Setting up topic branches and generating pull requests

While it's handy to provide useful code snippets in an issue, it is better for
you as a developer to submit pull requests. By submitting pull request your
contribution to django-crispy-forms will be recorded by Github.
contribution to django-crispy-forms will be recorded by GitHub.

In git it is best to isolate each topic or feature into a "topic branch". While
individual commits allow you control over how small individual changes are made
Expand All @@ -47,7 +47,7 @@ While it takes some experience to get the right feel about how to break up
commits, a topic branch **must** be limited in scope to a single ``issue`` as
submitted to an issue tracker.

Also since github pegs and syncs a pull request to a specific branch, it is the
Also since GitHub pegs and syncs a pull request to a specific branch, it is the
**ONLY** way that you can submit more than one fix at a time. If you submit
a pull from your master branch, you can't make any more commits to your master
without those getting added to the pull.
Expand All @@ -64,22 +64,22 @@ master as described below.

When you are ready to generate a pull request, either for preliminary review,
or for consideration of merging into the project you must first push your local
topic branch back up to github::
topic branch back up to GitHub::

git push origin fix-broken-thing

Now when you go to your fork on github, you will see this branch listed under
Now when you go to your fork on GitHub, you will see this branch listed under
the "Source" tab where it says "Switch Branches". Go ahead and select your
topic branch from this list, and then click the "Pull request" button.

Here you can add a comment about your branch. If this in response to
a submitted issue, it is good to put a link to that issue in this initial
comment. The repo managers will be notified of your pull request and it will
be reviewed (see below for best practices). Note that you can continue to add
commits to your topic branch (and push them up to github) either if you see
commits to your topic branch (and push them up to GitHub) either if you see
something that needs changing, or in response to a reviewer's comments. If
a reviewer asks for changes, you do not need to close the pull and reissue it
after making changes. Just make the changes locally, push them to github, then
after making changes. Just make the changes locally, push them to GitHub, then
add a comment to the discussion section of the pull request.

Pull upstream changes into your fork regularly
Expand All @@ -100,7 +100,7 @@ Then merge the changes that you fetched::

git merge django-crispy-forms/master

For more info, see http://help.github.com/fork-a-repo/
For more info, see https://help.github.com/fork-a-repo/

How to get your Pull Request accepted
=====================================
Expand Down
2 changes: 1 addition & 1 deletion docs/crispy_tag_forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ What you'll get is the form rendered as HTML with awesome bits. Specifically...
<input type="submit" name="submit" value="Submit" class="submit submitButton" id="submit-id-submit" />
</div>

.. _`Be careful how you use static variables in forms`: http://tothinkornottothink.com/post/7157151391/be-careful-how-you-use-static-variables-in-forms
.. _`Be careful how you use static variables in forms`: https://tothinkornottothink.com/post/7157151391/be-careful-how-you-use-static-variables-in-forms


Manipulating a helper in a view
Expand Down
26 changes: 13 additions & 13 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,17 @@ Well, I'm obviously biased for answering this question. But I once `answered it
How did this all get started?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In December 2008, while `Daniel Greenfeld`_ was working for `NASA's Science Mission Directorate`_, his team began to use Django_ and Pinax_. There was a necessity to make all the forms in Pinax `Section 508`_ compatible, and the thought of going through all of forms and rewriting ``{{ form }}`` as a block of ``{% for field in form %}`` with all the template logic seemed like way too much work.
In December 2008, while `Daniel Feldroy`_ was working for `NASA's Science Mission Directorate`_, his team began to use Django_ and Pinax_. There was a necessity to make all the forms in Pinax `Section 508`_ compatible, and the thought of going through all of forms and rewriting ``{{ form }}`` as a block of ``{% for field in form %}`` with all the template logic seemed like way too much work.

So with the encouragement of `Katie Cunningham`_, `James Tauber`_ and `Jannis Leidel`_ Daniel took the Django docs on forms and combined it with Dragan Babic's excellent Uni-Form css/javascript library and created the ubiquitous ``as_uni_form`` filter. After that, fixing all the forms in Pinax to be section 508 compliant was trivial.
So with the encouragement of `Katie Cunningham`_, `James Tauber`_ and `Jannis Leidel`_ Daniel took the Django docs on forms and combined it with Dragan Babic's excellent Uni-Form CSS/JavaScript library and created the ubiquitous ``as_uni_form`` filter. After that, fixing all the forms in Pinax to be section 508 compliant was trivial.

Not long before PyCon 2009 James Tauber suggested the ``{% uni_form form helper %}`` API, where one could trivially create forms without writing any HTML.

At PyCon 2009 Jannis Leidel helped Daniel through releasing the 0.3 release of django-uni-form on PyPI. It was also at that PyCon when the project moved from Google Code to Github.

Around January 2011 the project wasn't very active, Github issues and forks were stacking up. At that time `Miguel Araujo`_ found django-uni-form and loved the concept behind its architecture. He started working in a fork of the project, trying to gather some old submitted patches. Around march of 2011, after conversations with Daniel, he got commit powers in the project's repository, reactivating dev branch. Releases 0.8.0, 0.9.0 followed and the project more than doubled its watchers in Github.

By the end of 2011, Miguel and Daniel agreed on the necessity of renaming the project. As uni-form CSS framework was not anymore the only option available and the name was confusing the users. Thus django-crispy-forms was born, named by `Audrey Roy`_. The project is now actively maintained and leaded by `Miguel Araujo`_.
By the end of 2011, Miguel and Daniel agreed on the necessity of renaming the project. As uni-form CSS framework was not anymore the only option available and the name was confusing the users. Thus django-crispy-forms was born, named by `Audrey Feldroy`_. The project is now actively maintained and leaded by `Miguel Araujo`_.

.. _faq-how-fast:

Expand Down Expand Up @@ -87,13 +87,13 @@ Which versions of Django does this support?

Versions supported include Django 1.3 or higher. Versions of django-crispy-forms below 1.3 support Django 1.2.x. If you need to support earlier versions you will need to use django-uni-form 0.7.0.

.. _`Daniel Greenfeld`: http://twitter.com/pydanny
.. _`Miguel Araujo`: http://twitter.com/maraujop
.. _`Audrey Roy`: http://twitter.com/audreyr
.. _`Katie Cunningham`: http://twitter.com/kcunning
.. _Django: http://djangoproject.com
.. _Pinax: http://pinaxproject.com
.. _`NASA's Science Mission Directorate`: http://science.nasa.gov
.. _`Section 508`: http://en.wikipedia.org/wiki/Section_508
.. _`James Tauber`: http://jtauber.com/
.. _`Jannis Leidel`: http://twitter.com/jezdez
.. _`Daniel Feldroy`: https://twitter.com/pydanny
.. _`Miguel Araujo`: https://twitter.com/maraujop
.. _`Audrey Feldroy`: https://twitter.com/audreyfeldroy
.. _`Katie Cunningham`: https://twitter.com/kcunning
.. _Django: https://djangoproject.com
.. _Pinax: https://pinaxproject.com
.. _`NASA's Science Mission Directorate`: https://science.nasa.gov
.. _`Section 508`: https://en.wikipedia.org/wiki/Section_508
.. _`James Tauber`: https://jtauber.com
.. _`Jannis Leidel`: https://twitter.com/jezdez
2 changes: 1 addition & 1 deletion docs/filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Using {% crispy %} tag because it rocks

As handy as the `|crispy` filter is, think of it as the built-in methods: ``as_table``, ``as_ul`` and ``as_p``. You cannot tune up the output. The best way to make your forms crisp is using the :ref:`crispy tag forms`. It will change how you do forms in Django.

.. _`original implementation`: http://code.google.com/p/django-uni-form/source/browse/trunk/uni_form/templatetags/uni_form.py?spec=svn2&r=2
.. _`original implementation`: https://code.google.com/p/django-uni-form/source/browse/trunk/uni_form/templatetags/uni_form.py?spec=svn2&r=2
8 changes: 4 additions & 4 deletions docs/form_helper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,16 @@ Helper attributes you can set
Allows you to set what template pack you want to use at ``FormHelper`` level. This is useful for example when a website needs to render different styling forms for different use cases, like desktop website vs smartphone website.

**template**
When set allows you to render a form/formset using a custom template. Default template is at ``{{ TEMPLATE_PACK }}/[whole_uni_form.html|whole_uni_formset.html]``
When set allows you to render a form/formset using a custom template. Default template is at ``{{ TEMPLATE_PACK }}/[whole_uni_form.html|whole_uni_formset.html]``.

**field_template**
When set allows you to render a form/formset using a custom field template. Default template is at ``{{ TEMPLATE_PACK }}/field.html``.

**form_method = 'POST'**
Specifies form method attribute. You can see it to POST or GET. Defaults to POST
**form_method = ``POST``**
Specifies form method attribute. You can see it to ``POST`` or ``GET``. Defaults to ``POST``.

**form_action**
Applied to the form action attribute. Can be a named url in your URLconf that can be executed via the {% url %} template tag. Example: ‘show_my_profile’. In your URLconf you could have something like::
Applied to the form action attribute. Can be a named URL in your URLconf that can be executed via the {% url %} template tag. Example: ‘show_my_profile’. In your URLconf you could have something like::

url(r'^show/profile/$', 'show_my_profile_view', name='show_my_profile')

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ Think this is awesome and want to make it better? Read our contribution page, ma
contributing

.. _contributors: https://github.com/django-crispy-forms/django-crispy-forms/blob/master/CONTRIBUTORS.txt
.. _Django: http://djangoproject.com
.. _Django: https://djangoproject.com
10 changes: 5 additions & 5 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@ You can set your default template pack for your project using the ``CRISPY_TEMPL

Please check the documentation of your template pack package for the correct value of the ``CRISPY_TEMPLATE_PACK`` setting (there are packages which provide more than one template pack).

.. _`Bootstrap`: http://twitter.github.com/bootstrap/index.html
.. _`Foundation`: http://foundation.zurb.com/
.. _`Bootstrap`: https://getbootstrap.com
.. _`Foundation`: https://get.foundation
.. _`crispy-forms-foundation`: https://github.com/sveetch/crispy-forms-foundation
.. _`Tailwind`: https://tailwindcss.com/
.. _`Tailwind`: https://tailwindcss.com
.. _`crispy-tailwind`: https://github.com/django-crispy-forms/crispy-tailwind

Setting media files
Expand All @@ -67,5 +67,5 @@ Setting media files
crispy-forms does not include static files. You will need to include the proper corresponding media files yourself depending on what CSS framework (Template pack) you are using. This might involve one or more CSS and JS files. Read CSS framework's docs for help on how to set it up.


.. _Django: http://djangoproject.com
.. _`Uni-form`: http://sprawsm.com/uni-form
.. _Django: https://djangoproject.com
.. _`Uni-form`: https://sprawsm.com/uni-form
4 changes: 2 additions & 2 deletions docs/layouts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ These ones live under module ``crispy_forms.bootstrap``.
.. image:: images/field_with_buttons.png
:align: center

- **Tab & TabHolder**: ``Tab`` renders a tab, different tabs need to be wrapped in a ``TabHolder`` for automatic javascript functioning, also you will need ``bootstrap-tab.js`` included in your static files::
- **Tab & TabHolder**: ``Tab`` renders a tab, different tabs need to be wrapped in a ``TabHolder`` for automatic JavasSript functioning, also you will need ``bootstrap-tab.js`` included in your static files::

TabHolder(
Tab('First Tab',
Expand All @@ -272,7 +272,7 @@ These ones live under module ``crispy_forms.bootstrap``.
.. image:: images/tab_and_tabholder.jpg
:align: center

- **Accordion & AccordionGroup**: ``AccordionGroup`` renders an accordion pane, different groups need to be wrapped in an ``Accordion`` for automatic javascript functioning, also you will need ``bootstrap-tab.js`` included in your static files::
- **Accordion & AccordionGroup**: ``AccordionGroup`` renders an accordion pane, different groups need to be wrapped in an ``Accordion`` for automatic JavaScript functioning, also you will need ``bootstrap-tab.js`` included in your static files::

Accordion(
AccordionGroup('First Group',
Expand Down

0 comments on commit 77af82c

Please sign in to comment.