Structural Changes for Scaling Up, New Landing Page. (#22)

* Added new landing page, moved features and reorganized some files for handling scope expansion. This commit targeted at adding new landing page and enabling glightbox featuers. As such, I added glightbox plugin to yml. Added new index.md landing page which is shorter and allows folks to fork off quickly based on their 'cognitive use case', i.e. users don't think like admins, etc. Need to anticipate laymen users eventually referring to these docs. Renamed previous index.md to 'features.md. and moved to own folder, adjusted YML file nav section accordingly. Moved all screenshots supporting features.md to subfolder within features folder to keep relative paths intact. Ultimate goal is to have mkdocs folder structure mimic the navigation structure. Its cognitively clearer. * Reorganized all the files for scaling up Changed YML to reflect sub-folders. Removed 'requirements.md' file as the info was present elsewhere, it looked like a 'snippets' file. Expect to add example screenshots and discretizing the project into subfolders will make image management easier. The folder structure mimics the current navigation so its quite logical. Also renamed some files for consistency, some were camel-case, others not. Now all lower case filenames for consistency. * small changes per David Comments on PR #22 #22 (comment)
gramps-project · Sep 28, 2024 · 61f998c · 61f998c
1 parent c1c1020
commit 61f998c
Show file tree

Hide file tree

Showing 53 changed files with 334 additions and 244 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .venv
 .DS_Store
 .idea*
-.packer_cache
+.packer_cache
+*.bbprojectd
diff --git a/docs/admin.md → docs/administration/admin.md b/docs/admin.md → docs/administration/admin.md
@@ -1,4 +1,4 @@
-# Gramps Web Family Tree Administration
+# Gramps Web Administrator's Guide
 
 Whether you have set up your own instance of Gramps Web or signed up for a pre-installed one, the next step is to populate and manage your family tree database.
 

diff --git a/docs/user-guide/export.md → docs/administration/export.md b/docs/user-guide/export.md → docs/administration/export.md
diff --git a/docs/user-guide/import.md → docs/administration/import.md b/docs/user-guide/import.md → docs/administration/import.md
diff --git a/docs/user-guide/owner.md → docs/administration/owner.md b/docs/user-guide/owner.md → docs/administration/owner.md
diff --git a/docs/user-guide/sync.md → docs/administration/sync.md b/docs/user-guide/sync.md → docs/administration/sync.md
diff --git a/docs/contribute.md → docs/contribute/contribute.md b/docs/contribute.md → docs/contribute/contribute.md
diff --git a/docs/dev-backend/api.md → docs/development/backend/api.md b/docs/dev-backend/api.md → docs/development/backend/api.md
diff --git a/docs/dev-backend/index.md → docs/development/backend/index.md b/docs/dev-backend/index.md → docs/development/backend/index.md
diff --git a/docs/dev-backend/queries.md → docs/development/backend/queries.md b/docs/dev-backend/queries.md → docs/development/backend/queries.md
diff --git a/docs/dev-backend/setup.md → docs/development/backend/setup.md b/docs/dev-backend/setup.md → docs/development/backend/setup.md
diff --git a/docs/dev.md → docs/development/dev.md b/docs/dev.md → docs/development/dev.md
diff --git a/docs/dev-frontend/architecture.md → docs/development/frontend/architecture.md b/docs/dev-frontend/architecture.md → docs/development/frontend/architecture.md
diff --git a/docs/dev-frontend/build.md → docs/development/frontend/build.md b/docs/dev-frontend/build.md → docs/development/frontend/build.md
diff --git a/docs/dev-frontend/index.md → docs/development/frontend/index.md b/docs/dev-frontend/index.md → docs/development/frontend/index.md
diff --git a/docs/dev-frontend/setup.md → docs/development/frontend/setup.md b/docs/dev-frontend/setup.md → docs/development/frontend/setup.md
diff --git a/docs/dev-frontend/translation.md → docs/development/frontend/translation.md b/docs/dev-frontend/translation.md → docs/development/frontend/translation.md
diff --git a/docs/features/features.md b/docs/features/features.md
@@ -0,0 +1,203 @@
+---
+hide:
+  - toc
+  - navigation
+---
+
+---
+
+![Image title](screenshots/sync.png){ align=right width="300"}
+
+## Full integration with Gramps Desktop
+
+Gramps Web uses the same **Model / Database** structure that [Gramps Desktop](https://gramps-project.org/) uses for storing genalogical data.  You can browse all the same [Record Types](https://gramps-project.org/wiki/index.php/Gramps_Data_Model) you do in Gramps Desktops: ***people, families, events, places, repositories, sources, citations, media objects, and notes.***
+
+Using the [Gramps Web Add-on](https://gramps-project.org/wiki/index.php/Addon:Gramps_Web) for Gramps Desktop, data can be synchronized bi-directionally between Gramps Web and Gramps Desktop! Go ahead and edit your data with Gramps Web or the Gramps Desktop App which you know and love - they work together seamlessly!
+
+<div style="clear:both;"></div>
+---
+
+![Image title](screenshots/list.png){ align=right width="400"}
+
+## Privacy Levels / User Access
+
+Many folks want to keep some details private and we respect that!  You can mark Records as Private and control which users are allowed to view private records. Private records are filtered out at the database layer for maximum security.  In addition, you can control what users are able to add and edit. 
+
+<div style="clear:both;"></div>
+---
+
+
+
+![Image title](screenshots/mobile.png){ align=left width="400"}
+
+##	Web Browser Convenience
+
+Access Gramps Web from any web-enabled Device.  You can upload photos, create or edit Records, show your Family Tree to others, or look up those Family member names you can't remember at your next Family Reunion!
+
+
+<div style="clear:both;"></div>
+---
+
+
+
+![Image title](screenshots/fan.png){ align=right width="400"}
+
+## Interactive family tree graphs
+
+Navigate your family tree as an ancestor chart, descendant chart, hourglass chart, or as fan chart, with high-quality interactive graphics and configurable number of generations.
+
+
+<div style="clear:both;"></div>
+
+---
+
+
+
+![Image title](screenshots/map.png){ align=left width="400"}
+
+## Powerful map
+
+Display all places on an interactive, searchable map.
+
+Turn a historical map stored as media object in Gramps into a custom map overlay.
+
+
+<div style="clear:both;"></div>
+
+---
+
+
+
+![Image title](screenshots/blog.png){ align=right width="400"}
+
+## Genealogy Blog included
+
+Summarize your research in the form of blog stories with pictures. All data is stored in the Gramps database.
+
+
+<div style="clear:both;"></div>
+
+---
+
+
+
+![Image title](screenshots/lang.png){ align=left width="300"}
+
+## Fully internationalized
+
+Switch the language of the interface between any of 40 languages translated by the Gramps community.
+
+
+<div style="clear:both;"></div>
+
+---
+
+
+
+
+
+![Image title](screenshots/export.png){ align=right width="300"}
+
+## No lock-in &ndash; data import and export
+
+Apart from being able to import data in various formats including Gramps XML and GEDCOM, Gramps Web makes it easy for users to download all of their data (family tree data, media files, user accounts) anytime, for backup purposes or to move to a different server. Your data is yours alone!
+
+<div style="clear:both;"></div>
+
+---
+
+
+
+![Image title](screenshots/report.png){ align=left width="400"}
+
+## Generate printable reports
+
+Since it's built directly on the core powering Gramps Desktop, you can generate almost all of the [reports](https://gramps-project.org/wiki/index.php/Gramps_5.2_Wiki_Manual_-_Reports) the desktop app supports right from the browser, including relationship graphs or book reports as PDF.
+
+<div style="clear:both;"></div>
+
+
+
+---
+
+
+
+![Image title](screenshots/tag.png){ align=left width="400"}
+
+## Tag people in photos with automated face detection
+
+Collaborate with your relatives to identify ancestors in old family photos. Thanks to automated face detection, tagging people is just two clicks away.
+
+
+<div style="clear:both;"></div>
+
+---
+
+
+
+![Image title](screenshots/search.png){ align=right width="400"}
+
+## Powerful full-text search
+
+The search engine supports searching all Gramps object types, including the content of text notes, and supports wildcard syntax and logical operators.
+
+
+<div style="clear:both;"></div>
+
+---
+
+
+
+![Image title](screenshots/dna.png){ align=left width="400"}
+
+## DNA matches & chromosome browser
+
+If you have DNA match data from one of the DNA genealogy providers, upload it and store it in a future-proof way and view your matches in an interactive chromosome browser.
+
+<div style="clear:both;"></div>
+
+---
+
+
+![Image title](screenshots/tasks.png){ align=right width="400"}
+
+## Integrated task management app
+
+Gramps Web comes with an integrated task management app to organize and plan your genealogical research. The tasks are stored as sources in the Gramps database, so they form part of your genealogical data an can be accessed and edited in Gramps Desktop as well.
+
+
+<div style="clear:both;"></div>
+
+---
+
+
+![Image title](screenshots/ohm.png){ align=left width="400"}
+
+## Integration of OpenHistoricalMap
+
+The historical vector maps created by the [OpenHistoricalMap](https://www.openhistoricalmap.org/) project are the perfect complement to genealogical mapping. Use the time slider to scroll through the evolution of the places in your family history and display the places where ancestors lived or events happened.
+
+<div style="clear:both;"></div>
+
+<p>&nbsp;</p>
+
+---
+
+## Demo
+
+To login to the Demo, use any one of the following ***USER / PASS*** login credentials.  Each represent a user type that a Gramps Web user may be assigned to.
+
+`owner / owner` <br>
+`editor / editor` <br>
+`contributor / contributor` <br>
+`member / member`
+
+
+[Go to Demo Login](https://demo.grampsweb.org/){ .md-button .md-button--primary target="_blank"}
+
+
+### Thanks
+
+The demo is kindly supported by DigitalOcean.
+
+<a href="https://www.digitalocean.com/?refcode=b1d13ebe86ac&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge"><img src="https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%202.svg" alt="DigitalOcean Referral Badge" /></a>
diff --git a/docs/screenshots/blog.png → docs/features/screenshots/blog.png b/docs/screenshots/blog.png → docs/features/screenshots/blog.png
diff --git a/docs/screenshots/dna.png → docs/features/screenshots/dna.png b/docs/screenshots/dna.png → docs/features/screenshots/dna.png
diff --git a/docs/screenshots/export.png → docs/features/screenshots/export.png b/docs/screenshots/export.png → docs/features/screenshots/export.png
diff --git a/docs/screenshots/fan.png → docs/features/screenshots/fan.png b/docs/screenshots/fan.png → docs/features/screenshots/fan.png
diff --git a/docs/screenshots/lang.png → docs/features/screenshots/lang.png b/docs/screenshots/lang.png → docs/features/screenshots/lang.png
diff --git a/docs/screenshots/list.png → docs/features/screenshots/list.png b/docs/screenshots/list.png → docs/features/screenshots/list.png
diff --git a/docs/screenshots/map.png → docs/features/screenshots/map.png b/docs/screenshots/map.png → docs/features/screenshots/map.png
diff --git a/docs/screenshot.png → docs/features/screenshots/mobile.png b/docs/screenshot.png → docs/features/screenshots/mobile.png
diff --git a/docs/screenshots/new_event.png → docs/features/screenshots/new_event.png b/docs/screenshots/new_event.png → docs/features/screenshots/new_event.png
diff --git a/docs/screenshots/new_media.png → docs/features/screenshots/new_media.png b/docs/screenshots/new_media.png → docs/features/screenshots/new_media.png
diff --git a/docs/screenshots/ohm.png → docs/features/screenshots/ohm.png b/docs/screenshots/ohm.png → docs/features/screenshots/ohm.png
diff --git a/docs/screenshots/report.png → docs/features/screenshots/report.png b/docs/screenshots/report.png → docs/features/screenshots/report.png
diff --git a/docs/screenshots/search.png → docs/features/screenshots/search.png b/docs/screenshots/search.png → docs/features/screenshots/search.png
diff --git a/docs/screenshots/sync.png → docs/features/screenshots/sync.png b/docs/screenshots/sync.png → docs/features/screenshots/sync.png
diff --git a/docs/screenshots/tag.png → docs/features/screenshots/tag.png b/docs/screenshots/tag.png → docs/features/screenshots/tag.png
diff --git a/docs/screenshots/tasks.png → docs/features/screenshots/tasks.png b/docs/screenshots/tasks.png → docs/features/screenshots/tasks.png
diff --git a/docs/help.md → docs/help/help.md b/docs/help.md → docs/help/help.md