Comments (6)
Agreed. Now I'm trying to figure out how we can implement this change from a practical perspective.
@michaelmcandrew do you have ideas for how to make this ticket more actionable? I like the "separate tickets" idea, but I'm still not sure what criteria should be for this ticket to be "done" and closed. So far it would seem to require a complete manual scan of the User Guide which feels too demanding.
Our Style Guide currently says
For the User Guide only: We try and limit the content to tasks that the user can perform from the front end. This means that we don't go into detailed steps about installation or system administration tasks. We do however let people know that there are system administrator tasks out there (setting up an SSL certificate, configuring CiviMail etc.) and point them in the right direction when they want to know about those tasks.
Here's my proposal for how to act on this ticket:
- Add your suggested text to the aforementioned section of the Style Guide
- Close this ticket
- Keep our eyes out (just personally, not programmatically) for changes needed to bring the User Guide into compliance with this Style Guide criteria, and add new tickets as necessary.
What do you think about that @michaelmcandrew ?
from civicrm-user-guide.
yeah - I think Style guide is the place for this. The other option would be to have a big sprint task
label or similar that we could attach to tickets that are fairly mammouth but would be acheivable at a sprint if you split the work between 4 or 5 people, if you are into those kind of tickets that are open for a while, or you want to keep them closed. up to you.
from civicrm-user-guide.
This issue has had no activity in 60 days and has been marked as stale, it will be closed in 10 days.
from civicrm-user-guide.
I anticipate incorporating the concepts discussed in this issue in my development of a CiviCRM Documentation Guide.
from civicrm-user-guide.
Hi @dvhirst just to be clear - at this stage I am not neccessarily green-lighting adding a new documentation book - the content may make more sense living in the dev guide where it is now (there would need to be a significant amount of content to justify a new core book).
from civicrm-user-guide.
Either way - I look forward to reviewing the content :-)
from civicrm-user-guide.
Related Issues (20)
- Document the recommended CiviMail permissions for anonymous users HOT 3
- Document how to send an inline email image HOT 3
- Document accrual accounting, partial payments HOT 1
- Expand merging section to explain what happens to memberships when you merge contacts HOT 1
- Document Deferred Revenue HOT 1
- Clarify permissions for 'profile listings and forms' HOT 8
- Document all of CiviContribute Component Settings HOT 3
- Document CRM-19232: uploading docx/odt as message template HOT 1
- Documentation for Group ID is not (any longer?) accurate HOT 2
- Update ref to 'transgender' per https://lab.civicrm.org/dev/core/issues/993#note_18259 HOT 5
- Document passing parameters to CiviReport HOT 1
- Resource URL documentation is confusing and not updated for changes in 4.7+ HOT 1
- Document "smart group cache timeout" setting. HOT 3
- More info on weights etc in dedupe rules HOT 1
- CiviCRM User Guide Update: Understanding Unsubscribe vs. Opt Out HOT 1
- Tokens and click-through HOT 1
- Screenshot for event location page needs updating HOT 3
- Check and update localization instructions
- Document new CiviMail Tracking settings as per core PR #17291
- CiviMail workflow support is undocumented HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from civicrm-user-guide.