Skip to content

Commit

Permalink
edit doc index page
Browse files Browse the repository at this point in the history
  • Loading branch information
sdumetz committed Feb 19, 2024
1 parent 7b347b1 commit 4acd2f9
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 28 deletions.
4 changes: 3 additions & 1 deletion en/_drafts/scene_merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ After the previous step, we still can't handle the above example: Both users add

We need to remap the indices of the `nodes` array (as well as most other arrays in the document) to be able to uniquely identify their contents.

It is done by reducing the array to a map of unique keys. Fortunately the JSON-schema already defines a `id` property for most relevant array items. This key is unique within the array and can be used as a unique identifier. In places where an `id` is not available, we can use the node's name as a fallback.
It is done by reducing the array to a map of unique keys. Fortunately the JSON-schema already defines a `id` property for most relevant array items. This key is unique within the array and can be used as a unique identifier. In places where an `id` is not available, we tried to use another stable and unique property (like the url for assets). When all else fails, we updated the JSON-schema to add an `id` property.

## Keys remapping

Expand Down Expand Up @@ -231,3 +231,5 @@ Attentive readers may have noted that `scenes` targets have been omitted. This i
## Conclusion

With the scene file parsing taken care of, diffing and merging is just a matter of applying simple(ish) deep-compare and deep-merge functions.

We have now published the prototype behind a feature flag to begin in-situ testing. We will be able to gather feedback and improve the system as we go. The next big milestone will be to contribute the required change to the JSON-schema of voyager scenes to ensure compatibility with the ecosystem.
20 changes: 7 additions & 13 deletions en/doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,14 @@ <h2 id="Documentation" class="big-title-doc">Documentation</h2>

<h2 id="Introduction">Introduction</h2>
<p>
eCorpus is a reference implementation of <a href="https://holusion.com/en/" target="_blank">Holusion's</a> <a
href="https://smithsonian.github.io/dpo-voyager/" target="_blank">dpo-voyager</a> editor for hosting, editing
and managing scènes 3D.
eCorpus is an implementation of the <a href="https://smithsonian.github.io/dpo-voyager/"
target="_blank">dpo-voyager</a> editor for hosting, editing and managing 3D scenes.
</p>
<p>
Designed for medium-sized collections (1 to 1,000 objects), an eCorpus deployment offers a complete interface for
managing user rights and publishing data, as well as guarantees of data preservation through advanced management
of
modification histories.
Designed for medium-sized collections (up to about 1,000 objects), an eCorpus deployment offers a complete interface for managing user rights and publishing data, as well as guarantees of data preservation through advanced history management.
</p>
<p>
Development is open-source on <a href="https://github.com/Holusion/eCorpus" target="_blank">GitHub</a>. The entire
Development is open-sourced on <a href="https://github.com/Holusion/eCorpus" target="_blank">GitHub</a>. The entire
software is published under the <a href="https://github.com/Holusion/eCorpus/blob/main/LICENSE.md"
target="_blank">Apache</a> license.
</p>
Expand Down Expand Up @@ -64,10 +60,8 @@ <h3 id="Deployment">Deployment</h3>
<h3 id="Features">Features</h3>
<p>
<b>eCorpus</b> offers a set of administrative functions for managing users, collections, 3D scenes and annotations.
It's
a complete, ready-to-use server that can be deployed <a href="tutorials/deployment">in a matter of minutes</a>.
It's a complete, ready-to-use server that can be deployed <a href="tutorials/deployment">in a matter of minutes</a>.
</p>
<p>
In addition, advanced <b>Voyager</b> features are developed and integrated by Smithsonian teams deployment by
Smithsonian teams.
</p>
In addition, advanced <b>Voyager</b> features developed by the DPO-voyager team and community are integrated as they get released.
</p>
23 changes: 9 additions & 14 deletions fr/doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,20 @@ <h2 id="Documentation" class="big-title-doc">Documentation
<section>
<h2 id="Introduction">Introduction</h2>
<p>
eCorpus est une implémentation de référence de l'éditeur <a href="https://smithsonian.github.io/dpo-voyager/"
eCorpus est une intégration de l'éditeur <a href="https://smithsonian.github.io/dpo-voyager/"
target="_blank">dpo-voyager</a>
fournie par <a href="https://holusion.com/fr/" target="_blank">Holusion</a> permettant l'hébergement, l'édition et
la gestion de
scènes 3D.
développée par <a href="https://holusion.com/fr/" target="_blank">Holusion</a> permettant l'hébergement, l'édition et la gestion de scènes 3D.
</p>
<p>
Conçu pour des collections de taille moyenne (1 à 1000 objets),
Conçu pour des collections de taille moyenne (jusqu'à quelques milliers d'objets),
un déploiement eCorpus propose une interface complète de gestion des droits utilisateurs, de publication des
données
ainsi que des garanties de conservation des données à l'aide d'une gestion avancée des historiques de
données ainsi que des garanties de conservation des données à l'aide d'une gestion avancée des historiques de
modification.
</p>
<p>
Le développement se fait en open-source sur <a href="https://github.com/Holusion/eCorpus"
target="_blank">GitHub</a>. L'ensemble
du logiciel est publié sous license <a href="https://github.com/Holusion/eCorpus/blob/main/LICENSE.md"
du logiciel est publié sous license libre <a href="https://github.com/Holusion/eCorpus/blob/main/LICENSE.md"
target="_blank">Apache</a>.
</p>
</section>
Expand All @@ -46,8 +43,7 @@ <h3 id="Édition-contenu">Édition de contenu</h3>
</div>
<p>
L'édition de contenu repose sur l'éditeur <a href="https://smithsonian.github.io/dpo-voyager/story/overview/"
target="_blank">Voyager Story</a>
développé par le Smithsonian Institute.
target="_blank">Voyager Story</a> développé par le Smithsonian Institute, avec l'ajout de fonctionnalités essentielles à l'utilisation en environnement pédagogique: gestion des droits utilisateurs, historique des modifications, gestion des collections, etc.
</p>
<p>Découvrez comment éditer une Scène 3D :</p>
<div class="center-button">
Expand All @@ -60,7 +56,7 @@ <h3 id="Édition-contenu">Édition de contenu</h3>
<h3 id="Déploiement">Déploiement</h3>
<p>
Une petite instance eCorpus peut tourner sur à peu près <a href="./references/administration/requirements">n'importe
quel appareil</a>.
quel appareil</a>. L'installation se fait avec un minimum de dépendances externes.
</p>

<div class="center-button">
Expand All @@ -73,10 +69,9 @@ <h3 id="Fonctionnalités">Fonctionnalités</h3>
<p>
<b>eCorpus</b> propose un ensemble de fonctions administratives permettant de gérer les utilisateurs, les
collections, les scènes 3D et les annotations.
C'est un serveur complet et prêt à l'emploi qui peut être déployé en <a href="tutorials/deployment">quelques
C'est un serveur complet et prêt à l'emploi qui peut être déployé en <a href="./tutorials/deployment">quelques
minutes</a>.
</p>
<p>
Par ailleurs, des fonctionnalités avancées de l'éditeur <b>Voyager</b> sont développées et intégrées en amont de
leur déploiement par les équipes du Smithsonian.
En plus des fonctionnalités développées par Holusion, eCorpus intègre les derniers changements publiés par l'ensemble de la communauté pour l'éditeur <b>Voyager</b> au fur et à mesure de leur déploiement.
</p>

0 comments on commit 4acd2f9

Please sign in to comment.