Minor documentation improvements. #919

Merged
merged 6 commits into from Aug 4, 2011

Projects

None yet

3 participants

@kezabelle
Contributor
  • Document the public methods on NavigationNodes, including what I believe to be the rationale for methods which just return a instance attribute directly.
  • Add additional links to the contribution docs, specifically linking to:
    • freenode
    • both twitter accounts (behind SSL)
    • the github help on pull requests
    • what git is. Plenty of people will be coming from things like SVN and CVS.
    • the introduction docs on ReST.
  • Changed "cms" to "CMS" because it is an acronym.
  • modified the text about freenode to also mention it's an IRC network. Plenty of people new to OSS may not be aware of that.
@ojii ojii commented on an outdated diff Aug 3, 2011
docs/contribution.rst
@@ -32,8 +32,8 @@ only for the stuff we host on github:
#. The best method to contribute back is to create an account there, then fork
the project. You can use this fork as if it was your own project, and should
push your changes to it.
-#. When you feel your code is good enough for inclusion, "send us a pull
- request", by using the nice Github web interface.
+#. When you feel your code is good enough for inclusion, "send us a `pull
+ request`_", by using the nice Github web interface.
@ojii
ojii Aug 3, 2011 Collaborator

while we're nitpicking: the official spelling is GitHub :D

@ojii ojii commented on the diff Aug 3, 2011
docs/contribution.rst
@@ -45,7 +45,7 @@ Contributing Code
Getting the source code
=======================
-If you're interested in developing a new feature for the cms, it is recommended
+If you're interested in developing a new feature for the CMS, it is recommended
@ojii
ojii Aug 3, 2011 Collaborator

maybe make this 'django CMS'?

@kezabelle
kezabelle Aug 4, 2011 Contributor

I was going to ask in IRC today, actually - there's a few places I think where it's not consistent, and while I thought there was an official stance on it being "django CMS" with caps like that, I couldn't find it last night. If that's the case, I can add that to the pull request later.

@ojii ojii commented on the diff Aug 3, 2011
docs/contribution.rst
+.. _Github help : http://help.github.com
+.. _freenode : http://freenode.net/
+.. _@djangocmsstatus : https://twitter.com/djangocmsstatus
+.. _@djangocms : https://twitter.com/djangocms
+.. _pull request : http://help.github.com/send-pull-requests/
+.. _git : http://git-scm.com/
+.. _restructuredText: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
+
@ojii
ojii Aug 3, 2011 Collaborator

nice, those links will be helpful for new people!

@chrisglass
chrisglass Aug 4, 2011 Collaborator

Yeah that's epic

@ojii ojii commented on an outdated diff Aug 3, 2011
docs/extending_cms/api_references.rst
@@ -260,3 +260,23 @@ menus.base
this node.
:param bool visible: Optional, defaults to ``True``, whether this item is
visible or not.
+
+
+ .. method:: get_descendents
@ojii
ojii Aug 3, 2011 Collaborator

typo, should be get_descendants

@kezabelle
Contributor

Paging eyes to check over the new diff, which has become a little more substantial, without radically altering anything.

@ojii
Collaborator
ojii commented Aug 4, 2011

wow amazing

@ojii ojii merged commit eeab29e into divio:develop Aug 4, 2011
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment