Giter VIP home page Giter VIP logo

documentation's Introduction

Testing Status

Plone Documentation

This is the repository for Plone Documentation.

Plone 6

Browse the Plone 6 Documentation at https://6.docs.plone.org/.

Active development on the Plone 6 Documentation takes place on the branch 6.0.

Plone 5.2

Browse the Plone 5.2 Documentation at https://5.docs.plone.org/.

Development on the Plone 5.2 Documentation takes place on the branch 5.2.

Contribute

Contributing to frontend (Volto), plone.api, and plone.restapi documentation

Plone documentation consists of this repository, plone/documentation, and it includes external packages' documentation through git submodules. Those packages include:

To contribute documentation, please open a pull request in the appropriate repository. For details, see Editing external package documentation.

Support

For technical support for Plone documentation only, please ask a question on our Community Forum, Documentation category.

For technical support for Plone in general, please ask a question on our Community Forum in the appropriate category.

Training

Training is a collection of different trainings, developed and created by the Plone Community.

For an HTML version, please browse to our Training Website.

License

The project is licensed under the Creative Commons Attribution 4.0 International License by the Plone Foundation.

documentation's People

Contributors

davisagli avatar ericof avatar erral avatar esteele avatar fredvd avatar gforcada avatar ichim-david avatar jensens avatar ksuess avatar lord2anil avatar mauritsvanrees avatar max-786 avatar mikejmets avatar mrtango avatar nileshgulia1 avatar pbauer avatar petschki avatar polyester avatar rber474 avatar rudd-o avatar santonelli avatar sneridagh avatar stevepiercy avatar thet avatar tiberiuichim avatar toalba avatar utkkkarshhh avatar valentinab25 avatar wolbernd avatar yurj avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation's Issues

What manuals to include?

atm. we are including:
plone.api
plone.schemaeditor
plone.dexterity
plone.app.contentrules
plone.app.contentrules
plone.app.dexterity
plone.app.multilingual
plone.app.portlets
plone.app.robotframework
plone.app.testing
plone.app.theming
plone.app.viewletmanager
plone.app.workflow
ploneorg.admin - this will not be done
Products.CMFEditions
Products.DCWorkflow
Products.GenericSetup
Products.ResourceRegistries
Products.TinyMCE
sphinxcontrib.contributors
tutorials.todoapp

is this still up 2 date information ? do we want to include others like PloneFormGen ?

Add installation chapter?

Hi, I just wondered, if we also want an installation-section in the docs, where we could provide and collect reliable recipes to set up dev-builds by using virtualenv, e.g.? If you think that would be helpful, I'd like to start to write it, just would need assistance on how to create a new chapter, then.

Title case for headings in the docs. Being consistent.

I'd like to recommend that headings in the documentation use Title case with words like "to" and "a" remaining common, proper nouns like "Plone" should ALWAYS be captilized.

For example:

How to Capitalize Plone Documentation Headings

as opposed to sentence case:

How to capitalize Plone documentation headings

Capitalize the first word of the title, the last word of the title, and all “principal” words (that’s essentially the same parts of speech I just listed—nouns, verbs and so on), and all words longer than three letters. That is the style currently recommended by the Associated Press (2). (You can see one of the major differences between Chicago and AP style is that in Chicago style, a long preposition such as “between” would not usually be capitalized, whereas in AP style, it would.) - See more at: http://www.quickanddirtytips.com/education/grammar/capitalizing-titles#sthash.8flAJY7P.dpuf

I'm happy to starting doing this, assuming it is endorsed (plus I owe some documentation work from the last sprint :) ).

How to contibute to documentation

write howto about that, include also stuff like:

Git workflow / branching model

It is important that you NEVER commit to master directly. Even for the smallest and most trivial fix. ALWAYS open a pull request and ask somebody else to merge your code. NEVER merge it yourself.

If you don't get feedback on your pull request in a day please come to #plone-framework and ping @garbas or @vangheem about it.

The main goal of this process is not to boss developers around and make their lives harder, but to bring greater stability to the development of mockup and to make releases smooth and predictable.
Pull request checklist

Checklist of things that every person accepting pull request should follow (or else @garbas will make you drink a Mongolian cocktail - I promise!).

The title and description of a pull request MUST be descriptive and need to reflect the changes in code. Please review, line by line, and comment if the code change was not mentioned in the description of the pull request.

Copy the title of the pull request to the current ticket tracking changes for release under development. (example: https://github.com/plone/mockup/issues/250)

The full test suite (which runs the tests on saucelabs against real browsers) will only be triggered for the master branch and the pull requests. It is important that the tests pass before you merge it.

Please note that the Travis job sometimes hangs (for various reasons) and then you need to restart it.

Due to some bugs in Travis regarding reporting of the status, be sure to always check on https://travis-ci.org/plone/mockup/pull_requests that the tests really have passed.

It is important to never lower code coverage. Check coveralls to see that coverage hasn't dropped. It should be reported automatically once the tests pass.

Make sure that every new function (or bigger chunk of code) that is added to mockup is tested.

All commits need to be rebased on current master and squashed into one single commit. The commit's title (first line) and description (row 3 and below) should be identical to the pull request.

Once you've ensured that all the above is correct, go ahead and merge the pull request. Make sure you always use a polite tone and explain why this is needed by linking to this document.

change this to documentation, this is taken from: http://plone.github.io/mockup/dev/#contribute

integrate transmogrifier documentation

collective.transmogrifier has re-arranged their docs to be in a format we can integrate. Let's look at the mind-map, think, and determine a good place where they should go

Tools for starting developer

Include docs over handy tools, trips and tricks for starting developers, like search plugins, editor configs and testing applications

Check consistency on guidelines

I just wrote this StackOverflow question: http://stackoverflow.com/questions/22760485/how-one-should-check-for-a-permission-in-plone

Which basically boils down to: from two different documentations in current developer.plone.org we get two different ways to check for a permission, which is the one that should be used?

So maybe it would be a good idea to create some small tips/recipes on how to do things and never ever let any documentation try to explain that, but instead refer to this tips/recipes.

This way we keep everything consistent and always easy to get up to date.

Move/Check/Update SSL/HTTPS

SSL/HTTPS

on kb old we have long and old example guide over apache with ssl on the current docs we have two short examples, we should check them and if necessary update them

list of errors for externally-included docs

collective/tutorial.todoapp: index, list of modules, own searchbox not working, has GH warning
plone.api: has GH warning
plone.app.testing: index, list of modules, own searchbox not working
(beginning to suspect this is an artifact of sphinx defaults...)

create recipe.plone.documentation

we want to have a recipe with a default sphinx setup, folder structure and such stuff, like a for example a default site which fetches, git repo, about, author and so on from setup.py

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.