|
|
| Line 1: |
Line 1: |
| = Using Frappe Wiki =
| |
|
| |
|
| == 1. Installation ==
| |
|
| |
| === A. Frappe Cloud Installation ===
| |
|
| |
| # Go to your '''Dashboard'''.
| |
| # Choose '''Go to Site''' or '''Go to Server'''.
| |
|
| |
| '''If Site:'''
| |
| * Select the site.
| |
| * Go to '''Apps'''.
| |
| * Click '''Install App'''.
| |
| * Select '''Wiki'''.
| |
|
| |
| '''If Server:'''
| |
| * Go to '''Application Server'''.
| |
| * Click '''Install App'''.
| |
| * Select '''Wiki'''.
| |
|
| |
| === B. Self-Hosted Installation ===
| |
|
| |
| '''If Docker-based setup:'''
| |
| * Ensure persistence using '''drive volumes''' so changes are not lost after restart.
| |
| * Execute via terminal:
| |
| <syntaxhighlight lang="bash">
| |
| bench get-app https://github.com/frappe/wiki
| |
| bench --site sitename install-app wiki
| |
| </syntaxhighlight>
| |
| * Follow [https://github.com/frappe/wiki official instructions] for installation.
| |
|
| |
| '''If VM setup:'''
| |
| * Access the command line.
| |
| * Run:
| |
| <syntaxhighlight lang="bash">
| |
| bench get-app https://github.com/frappe/wiki
| |
| bench --site sitename install-app wiki
| |
| </syntaxhighlight>
| |
| * Start your bench server:
| |
| <syntaxhighlight lang="bash">
| |
| bench start
| |
| </syntaxhighlight>
| |
|
| |
| == 2. Creating and Editing Wiki Pages ==
| |
|
| |
| === Creating Markdown Versions of Documents ===
| |
|
| |
| * Upload files to '''Google Drive'''.
| |
| * Download as '''Markdown (.md)'''.
| |
| * Alternatively, use '''ChatGPT Canvas mode''' to export to markdown.
| |
| * Edit <code>.md</code> files using any text editor.
| |
|
| |
| === Creating a Wiki Page ===
| |
|
| |
| # Navigate to '''Wiki > Wiki Page'''.
| |
| # Click '''Add Wiki Page'''.
| |
| # Enter the '''Title''' and '''Route'''.
| |
| # (Optional) Uncheck '''Allow Guest''' if you want restricted access.
| |
|
| |
| === Creating from Website Interface ===
| |
|
| |
| # Click your '''Profile Icon''' (top-right corner).
| |
| # Select '''View Website'''.
| |
| # Navigate to your wiki (e.g., <code>https://yourdomain.frappe.cloud/wiki/home</code>).
| |
| # Click '''Edit Sidebar''' to manage topics.
| |
| # Use the '''+ icon''' under each sidebar to add new pages.
| |
|
| |
| == 3. Sorting and Organizing Wiki Pages ==
| |
|
| |
| === Using Wiki Space ===
| |
|
| |
| # Go to '''Wiki Space'''.
| |
| # Select the '''Default Wiki'''.
| |
| # Under '''Wiki Space > Wiki''', organize the '''Parent Labels'''.
| |
| #* These will become sidebar sections.
| |
| # Add child pages under each parent label for collapsible sections.
| |
|
| |
| You can also create multiple wiki spaces for different departments or teams (e.g., HR, Accounting, Projects).
| |
|
| |
| == 4. Backup and Data Management ==
| |
|
| |
| === Backing Up Wiki Content ===
| |
|
| |
| You can back up your wiki using '''Data Import''':
| |
|
| |
| # Go to '''Data Import'''.
| |
| # Select '''Doctype: Wiki Page'''.
| |
| # Choose '''Update Entries'''.
| |
| # Click '''Download All Wiki Entries'''.
| |
|
| |
| This creates a JSON/CSV export of all your Wiki pages for backup or version control.
| |
|
| |
| == 5. Common Wiki Features ==
| |
|
| |
| {| class="wikitable"
| |
| ! Feature !! Description
| |
| |-
| |
| | '''Wiki Pages''' || Create and manage markdown-based documentation.
| |
| |-
| |
| | '''Wiki Space''' || Organize topics by category.
| |
| |-
| |
| | '''Wiki Feedback''' || Collect comments and feedback on pages.
| |
| |-
| |
| | '''Wiki Page Patches''' || Track edits or updates before publishing.
| |
| |-
| |
| | '''Wiki Settings''' || Configure permissions, visibility, and site links.
| |
| |-
| |
| | '''Wiki Page Revisions''' || View previous versions of each page.
| |
| |-
| |
| | '''Broken Links Report''' || Identify dead or missing links within the Wiki.
| |
| |}
| |
|
| |
| == 6. Recommended Practices ==
| |
|
| |
| * Use '''consistent titles and routes''' for better searchability.
| |
| * Always review '''Broken Links Report''' after restructuring.
| |
| * Maintain a '''single Wiki Space''' for each division (e.g., Accounting, HR, Projects).
| |
| * For collaborative editing, enable controlled publishing with '''Wiki Page Patches'''.
| |
|
| |
| == 7. Troubleshooting ==
| |
|
| |
| {| class="wikitable"
| |
| ! Issue !! Possible Cause !! Solution
| |
| |-
| |
| | Wiki not appearing in navbar || Navbar link not configured || Go to Website Settings > Navbar > Add Wiki link
| |
| |-
| |
| | Edits not saving || No persistent volume (Docker) || Mount volume or reconfigure persistent storage
| |
| |-
| |
| | Missing sidebar || No parent label in Wiki Space || Add Parent Label under Wiki Space
| |
| |-
| |
| | Access denied || Guest access disabled || Enable '''Allow Guest''' if public access is required
| |
| |}
| |
|
| |
| [[Category:ERPNext]]
| |
| [[Category:Wiki]]
| |
| [[Category:Documentation]]
| |
| [[Category:Comfac]]
| |
