-
-
Notifications
You must be signed in to change notification settings - Fork 409
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for logic customization #9325
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall this looks great but I think it needs some refining. I've left some suggestions below.
Also, I noticed we already have a "Customize" section in the documentation, e.g. how to customize the views:
https://docs.decidim.org/en/customize/views/
Or at GitHub:
https://github.com/decidim/decidim/tree/develop/docs/modules/customize/pages
I think this would be a natural place for this piece of documentation, we can name it e.g. customize/logic
, so it would become available at this URL after these changes:
https://docs.decidim.org/en/customize/logic/
As we discussed in another issue, the documentation might now be perfectly structured right now, but for this particular addition, let's first add it where it naturally belongs and later fix the issues with the navigational structure as a whole.
@ahukkanen |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great addition and contribution @sinaeftekhar!
I have some feedback, can you give it a look please? Thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few more improvement suggestions + please review one of the previous comments (I marked it as unresolved above).
- Fix indentation. - Update refered source code - Edit content
Changes to the content of the page was done according to reviews suggestion.
@andreslucena This is good for me, so feel free to merge once you are happy with it. Regarding your previous comment.
We have gone through several iterations of doing customizations within an instance and figured the concern way is probably the cleanest way to achieve this and keep track of what has changed. The decorator approach in the linked example doesn't look too bad but we prefer the concern way. As a real life example, I think the "Simple Proposal" module we've built is quite a good real life example (we use it with almost all of the smaller clients): Of course id doesn't demonstrate how to do the customizations directly from the application code but there's nothing stopping you from applying similar customizations from the application itself. |
To me too, of course. I was only talking about having two similar but different sections in the documentation navigation for modifying Ruby code. But I actually don't have it clear on how to do it, so when I have a proposal I'll make the PR. For sure, this is a clear improvement on what we have now!! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
* Add documentation page * Add Customization section * Edit documentation for the customization section * Resolve comments by the reviewer * Change the location of the files * Edit page title * Edit reviewer's comments - Fix indentation. - Update refered source code - Edit content * Edit content as reviewers' request Changes to the content of the page was done according to reviews suggestion. * resolve reviewer's commented issue
* Add documentation page * Add Customization section * Edit documentation for the customization section * Resolve comments by the reviewer * Change the location of the files * Edit page title * Edit reviewer's comments - Fix indentation. - Update refered source code - Edit content * Edit content as reviewers' request Changes to the content of the page was done according to reviews suggestion. * resolve reviewer's commented issue
🎩 What? Why?
Currently, decidim documentation is lacking logic customization. This section is added to the "Getting started section.
📋 Checklist
🚨 Please review the guidelines for contributing to this repository.
docs/
.