Skip to content
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

Migrate documentation to MKDocs #63

Closed
jensschuppe opened this issue Oct 18, 2018 · 6 comments
Closed

Migrate documentation to MKDocs #63

jensschuppe opened this issue Oct 18, 2018 · 6 comments
Labels
enhancement status:fixed The issue has been resolved (usually by committing/merging code).
Milestone

Comments

@jensschuppe
Copy link
Collaborator

In order for the extension's documentation to be published on https://docs.civicrm.org, it needs to be converted to MKDocs format.

Additionally, the current documentation should be revised for changes in described functionality or installation.

@jensschuppe
Copy link
Collaborator Author

jensschuppe commented Oct 18, 2018

0dea0f5 migrates the English version of the current documentation to MKDocs.

@bjendres This should be checked for accuracy and obsolescences for the current version of the extension.

The German documentation can then be adapted afterwards. Unfortunately, different languages need their own documentation repository.

@jensschuppe
Copy link
Collaborator Author

This might use an update for the new features in 1.6 and 1.7

@jensschuppe
Copy link
Collaborator Author

Documentation is missing for the new features:

  • unlockable fields for receipted contributions
  • watermark presets
  • e-mail exporter
    • Bounce handling
    • configurable "From" e-mail address
  • more tokens (Smarty variables) in templates
  • hooks
  • currency selection
  • anything else?

Installation instructions seem outdated as well.

Also, screenshots and step-by-step tutorials or at least an explanation of all configuration options and functionalities would be nice.

@grischard
Copy link

Currency selection is quite big - I'm currently avoiding this plugin because we receive donations in multiple currencies. Impatient to see the updated documentation :)

@jensschuppe jensschuppe added this to the 2.0 milestone Feb 4, 2020
@jensschuppe
Copy link
Collaborator Author

Since version 2.0 made major changes to the configuration UI, this should also go into the new MKDocs documentation.

@bjendres bjendres modified the milestones: 2.0, 2.1 Nov 27, 2020
@jensschuppe jensschuppe added the status:needs work There is code, but it needs additional work before it should be reviewed. label Mar 25, 2021
@jensschuppe jensschuppe modified the milestones: 2.1, 2.2 Feb 7, 2023
@jensschuppe jensschuppe mentioned this issue Feb 8, 2023
3 tasks
jensschuppe added a commit that referenced this issue Feb 8, 2023
[#63] Migrate documentation to MKDocs
@bjendres bjendres modified the milestones: 2.2, 2.3 Nov 2, 2023
@jensschuppe jensschuppe removed help wanted status:needs work There is code, but it needs additional work before it should be reviewed. labels Apr 18, 2024
@jensschuppe jensschuppe added the status:fixed The issue has been resolved (usually by committing/merging code). label Apr 18, 2024
@jensschuppe jensschuppe modified the milestones: 2.3, 2.1 Apr 18, 2024
@jensschuppe
Copy link
Collaborator Author

Migration to MKDocs has already been merged for 2.1.x, see #160 for actual updates of the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement status:fixed The issue has been resolved (usually by committing/merging code).
Projects
None yet
Development

No branches or pull requests

3 participants