Add documentation to the README file #79
Conversation
|
Trying to raise awareness for this request |
|
Just to add to this, it should be mentioned in the README that there is a button which has a list of the markdown placeholders that can be used. |
Added snippet about LDAP configuration.
|
Ya, If you could change the pull request to be against the github-dev branch, that would probably be better. The github-dev branch is generally more up to date and actually has a fair number of additions compared to the master branch. |
|
@TMDeal Unrelated to this PR, is the github-dev branch stable enough to run in production? |
Documented that you can also use a different syntax for placeholders
| # Path to a callable that takes a dict of {ldap_field_name: value}, | ||
| # returning a list of [ldap_search_filter]. The search filters will then be AND'd | ||
| # together when creating the final search filter. | ||
| LDAP_AUTH_FORMAT_SEARCH_FILTERS = "django_python3_ldap.utils.format_search_filters" |
There was a problem hiding this comment.
Now that this is merging into github-dev the LDAP portion of the README should be updated to reflect additions that have been made into github-dev regarding the search filters. The changes I am referring to can be found at writehat/settings.py:76 and writehat/config/writehat.conf:46.
|
@thejohnbrown, as of right now, the github-dev branch should be good to use for production. Given that it is being updated semi-frequently, I would recommend always being cautious when new changes are merged into it just to be on the safe side |
Greetings,
Long time follower, first time contributor. Thought I would add a bit of minor documentation destined to help WriteHat newbies like me:
Given that these are not code changes, thought I would make the PR against master - but please let me know if you would prefer that I make the PR against a dev branch.
Hope this is useful!