Commit graph

14 commits

Author SHA1 Message Date
Ali Al Saif
09934d576c
docs: reorganize documentation structure with numbered navigation (#1729)
* docs: reorganize documentation structure into logical categories

Restructure documentation into organized directories for better navigation:

- getting-started/: Quick start guides for new users
- setup/: Setup and configuration guides
- production/: Production deployment guides (backup, TLS, multi-tenancy)
- operations/: Site operations and management
- development/: Development workflow guides
- migration/: Migration guides
- troubleshooting/: Troubleshooting guides
- reference/: Reference documentation (container setup, build configs)

Rename files for consistency:
- Use kebab-case naming convention throughout
- Remove numbered prefixes from container-setup files
- Use descriptive names (backup-strategy, tls-ssl-setup, etc.)

Update all internal cross-references to reflect new file locations.
Update README.md with organized documentation structure.
Fix image paths in development.md to use correct relative paths.

* docs: add numeric prefixes to directories and files for navigation order

Add numeric prefixes (01-08) to documentation directories to indicate
reading order and flow for first-time users:

- 01-getting-started: Quick start guides
- 02-setup: Setup and configuration
- 03-production: Production deployment
- 04-operations: Site operations
- 05-development: Development guides
- 06-migration: Migration guides
- 07-troubleshooting: Troubleshooting
- 08-reference: Reference documentation

Add numeric prefixes to files within directories to guide readers
through documentation in a logical sequence.

Update all cross-references throughout documentation to use new
numbered paths. Update README.md to reflect the new structure.

* docs: move container-setup to 02-setup and integrate setup-options content

Move container-setup directory from 08-reference/ to 02-setup/ to follow
PR feedback. The container-setup documentation provides a more linear
and coherent flow compared to the previous unstructured setup files.

Changes:
- Move container-setup/ from docs/08-reference/ to docs/02-setup/
- Integrate content from setup-options.md into structured flow:
  - Create new 06-setup-examples.md with practical deployment scenarios
  - Enhance 03-start-setup.md with site creation details from setup-options
  - Remove redundant 01-setup-options.md (content now integrated)
- Rename 02-single-server-example.md to 07-single-server-example.md
- Update all cross-references throughout documentation:
  - Update README.md with new structure under Setup section
  - Fix links in site-operations.md and migration docs
  - Add navigation links between container-setup files and examples
- Maintain container-setup's linear flow: overview → build → start → env → overrides
- Add practical examples document (06-setup-examples.md) that follows the container-setup guide

Result: Documentation now follows a clear progression from conceptual
overview through practical examples, with all setup information properly
organized under 02-setup/.

* docs: remove container-setup subfolder and flatten structure

Move all files from docs/02-setup/container-setup/ directly into docs/02-setup/
to eliminate unnecessary subfolder. Files are already numbered sequentially,
so they work perfectly at the same level.

Changes:
- Move all files from container-setup/ subfolder to 02-setup/ root
- Remove container-setup/ subfolder
- Update all cross-references:
  - Update README.md paths (remove container-setup/ from all links)
  - Fix references in site-operations.md
  - Fix references in migration docs
  - Update internal references in 06-setup-examples.md
  - Fix relative path references in 01-overview.md, 02-build-setup.md, 03-start-setup.md

Result: Cleaner, flatter structure with all numbered setup files at the
same level, making navigation more straightforward.

* fix: Pre-commit failure is fixed

---------

Co-authored-by: adithya <adithya.a@bayesian.in>
2025-12-06 10:07:36 +05:30
YapWC
d505c91eab
Update Install Traefik Section (#1664)
Since the password would be parsed in single quote (') the text transformation is no longer needed. This update is based on issue #1002 (Unable to login to Traefik Dashboard even after providing Correct password in Basic Auth.)
2025-07-19 08:24:05 +05:30
Revant Nandgaonkar
85e164f34c revert: quote percent as mentioned in bench help 2024-12-10 15:48:00 +05:30
Revant Nandgaonkar
1505d125f1 fix: quote percent as mentioned in bench help 2024-12-10 15:36:18 +05:30
0xD0M1M0
598c7dab43 fix: --no-mariadb-socket & --mariadb-root-password is DEPRECATED 2024-12-07 15:30:46 +01:00
Anthony
855ce6cb0b
Update single-server-example.md (#1401)
Fix nonworking step - hashed password fails - per https://discuss.frappe.io/t/frappe-docker-unable-to-log-in-into-traefik/123077
2024-05-28 19:06:49 +05:30
0xD0M1M0
961453812c
fix: Fix gpg and less (#1321)
* fix: Add gpg and less

Add gpg so backup "bench --site yoursite.com backup --with-files --compress" does not fail if encryption is enabled

Add "less": fixes #1301

* fix: Add gpg and less

Add gpg so backup "bench --site yoursite.com backup --with-files --compress" does not fail if encryption is enabled

Add "less": fixes frappe#1301

* fix: Update documentation

update documentation to resemble current status

* fix: trailing whitespace

---------

Co-authored-by: Revant Nandgaonkar <revant.one@gmail.com>
2024-01-28 11:53:14 +05:30
vama
aaae152392
Updated grammer in single-server-example.md (#1265) 2023-11-02 04:25:08 +05:30
Revant Nandgaonkar
2e99af1a3f
fix: new-site command (#1260)
fix command usage and docs

fixes issue#1256
2023-10-30 11:45:55 +05:30
Azwal Zaman Mohammed
8b38448d8a
docs: change command for updating sites in single server example (#1107)
The previous command added an extra variable to the env file while keeping the default so I changed the command to update it with sed instead
2023-03-23 10:46:34 +05:30
Revant Nandgaonkar
e6088af885
refactor: build only one frappe/erpnext image (#1032)
* ci: skip frappe builds

* refactor: build only one frappe/erpnext image

* fix: lint nginx entrypoint script

* docs: update and organize docs

* docs: fix lint errors

* fix(custom): pass base64 encoded apps json

* ci: update dependabot

* docs: update contributing

* docs: remove info about multi image setup

* fix: initiate empty common_site_config.json

default config has host keys set to localhost
causes connection errors

* docs: add details for pwd volumes

* fix: symlink assets instead of copy

* fix: nginx private files

* ci: skip docker compose v2 install for ubuntu-latest

* fix: organize layers

* feat: allow remove git remote for custom image

* docs: allow remove git remote for custom image

* fix: remove duplicate --apps_path
2023-01-16 04:20:09 +05:30
Talbi Youssef
5c74ff9407
First instead of second Typo (#862) 2022-07-28 18:39:29 +05:30
Revant Nandgaonkar
b83938c0b8
docs: remove obsolete swarm related documentation (#763) 2022-04-06 15:33:40 +05:30
Revant Nandgaonkar
1448e46a9b
docs: single server setup example (#715)
* docs: single server setup example

* docs: lint single server setup example

* docs: LAN based setup

* docs: fix traefik ssl override

* docs: move data directory to user home

* docs: remove env-file from exec commands
2022-04-03 12:26:46 +05:30