Commit graph

21 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
Reuel Ramos Ribeiro
e6f7deec5c
Update development.md (#1600)
Clarify documentation about error. Solution was found at: https://discuss.frappe.io/t/youre-attempting-to-install-erpnext-version-15-with-frappe-version-16-this-is-not-supported-and-wi/127422
2025-04-01 16:32:19 +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
Dr.Blank
faa2065026
docs: fix grammar in administrator password instructions (#1504)
Correct redundant wording and improve clarity in site creation documentation.
2024-11-07 09:10:13 +05:30
Bowrna
8404d8946d
Update development.md (#1392)
* Update development.md

The extension name is renamed

* Update development.md
2024-05-07 10:31:44 +05:30
Bhavansathru
64cd39265b
Update development.md (#1274) 2023-11-23 14:14:04 +05:30
Bernhard Sirlinger
45200bd57f
feat: add optional mailpit configuration (#1269) 2023-11-14 03:10:15 +05:30
keerthana
f2dc0e8f6a
PYENV_VERSION=3.10.12 Deprecated (#1262)
The PYENV_VERSION 3.10.12 is deprecated the new version 3.10.13 was launched. here the reference link

https://hub.docker.com/_/python
2023-10-30 20:27:31 +05:30
Revant Nandgaonkar
27361b7500
docs: set-config for redis_socketio during development (#1261) 2023-10-30 11:56:22 +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
varun-krishnamurthy
ead5438ebb
Cypress UI Test service and updates to installer.py (#1250)
* #1247 #1248 Feat: Cypress UI testing + Postgres Arg for installer

* #1247 #1248 Feat: Cypress UI testing + Postgres Arg for installer

* #1247 #1248 Feat: Cypress UI testing + Postgres Arg for installer

* #1247 #1248 Feat: Cypress UI testing + Postgres Arg for installer

* #1247 #1248 Feat: Cypress UI testing + Postgres Arg for installer

* #1247 #1248 Feat: Cypress UI testing + Postgres Arg for installer

* #1247 #1248 Feat: Cypress UI testing + Postgres Arg for installer
2023-10-26 08:35:31 +05:30
Revant Nandgaonkar
839d44d167
fix: consume default queue (#1249) 2023-10-25 10:51:30 +05:30
Revant Nandgaonkar
f605addb71
refactor: prepare for v15 (#1243)
* chore: resolve merge conflict

* ci: changes for version 15

* chore: upgrade python and nodejs

* ci: fix v15 build

* fix: add redis_socketio for backward compatibility

* ci: fix v15 build

* ci: fix test endpoint

changed to erpnext.templates.pages.search_help.get_help_results_sections
2023-10-20 18:40:10 +05:30
Antony-M1
258fec25d2
3.9.9 deprecated (#1216)
* Update development.md

* 3.9.9 deprecated
2023-08-25 21:32:37 +05:30
Revant Nandgaonkar
8c670e6db7
docs: change sitename as per installer.py (#1196) 2023-07-31 05:10:23 +05:30
Revant Nandgaonkar
d5aae2097d
fix: use python for installer script (#1178) 2023-07-11 17:18:11 +05:30
Antony-M1
69fbc2ed91
Update development.md (#1168) 2023-07-06 05:30:14 +05:30
Revant Nandgaonkar
c013942d1f
fix: use docker volumes (#1067)
* fix: use docker volumes

remove bind mount
use docker volumes

* ci: remove payments app from tests
2023-01-31 09:48:52 +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
Renamed from development/README.md (Browse further)