v5 documentation

Lily Pregill

unread,

May 12, 2020, 2:55:21 PM5/12/20

to Arches Project

Hello,

Does anyone know if the current documentation has been updated for v5? The version history does not reflect v5:

v4.4 February, 2019: Release of Arches Collector mobile data collection app

v4.0 July, 2017: Significant site redesign, addition of graph creation UI, system settings UI, internal tileserver (TileStache), updated dependencies (MapBox GL, ElasticSearch 5.2, Yarn)

v3.0 April, 2015: Updated architecture, inclusion of the Reference Data Manager, updated dependencies (ElasticSearch, OpenLayers, Knockout)

v2.0 March, 2014: Improved upload of digital files, assorted bug fixes

v1.0 October, 2013: Initial Release

Thanks,

Lily

Lily Pregill, Systems Architect | The J. Paul Getty Trust | (310) 440 6394 | getty.edu

Mahmoud Abdelrazek

unread,

May 12, 2020, 3:11:52 PM5/12/20

to Arches Project

Hi Lily,

I am not sure if this is what you are looking for, but here is a link to v5 documentation https://arches.readthedocs.io/en/5.0.0/

Best regards,

Mahmoud

Lily Pregill

unread,

May 12, 2020, 3:31:35 PM5/12/20

to Mahmoud Abdelrazek, Arches Project

Thanks Mahmoud! I was looking at: https://arches.readthedocs.io/en/stable/overview/ and the version says 4.4.1.

On the v5 version, the page title of the Overview page reads "Overview 4.4.1" so something to fix.

best,

Lily

From: arches...@googlegroups.com <arches...@googlegroups.com> on behalf of Mahmoud Abdelrazek <raz...@gmail.com>
Sent: Tuesday, May 12, 2020 12:11 PM
To: Arches Project <arches...@googlegroups.com>
Subject: [Arches] Re: v5 documentation

--
-- To post, send email to arches...@googlegroups.com. To unsubscribe, send email to archesprojec...@googlegroups.com. For more information, visit https://groups.google.com/d/forum/archesproject?hl=en
---
You received this message because you are subscribed to the Google Groups "Arches Project" group.
To unsubscribe from this group and stop receiving emails from it, send an email to archesprojec...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/archesproject/6749807d-07b4-43e4-b5ca-f76dc059d0c8%40googlegroups.com.

CAUTION: This email originated from outside of the Getty. Do not click links or open attachments unless you verify the sender and know the content is safe.

Adam Cox

unread,

May 13, 2020, 1:52:06 PM5/13/20

to Lily Pregill, Mahmoud Abdelrazek, Arches Project

Hi Lily and Mahmoud, really, you're both right. A little of the structural work to set the documentation version to 5 has been done (as Mahmoud pointed out), however, to my knowledge there has been no concerted effort since the release of v5 to actually update the documentation in a holistic manner--just bits and pieces like software requirements, etc. I think a few days of a coordinated "documentation sprint" would go a really long way toward fixing that. I would be happy to play some sort of role in such an effort, because it would benefit the community hugely (obviously), but can't commit at this time to fully coordinating it... perhaps co-coordinating.

If others are interested in contributing their time or resources, I think we should use this thread to begin planning. I will also note that the documentation repo (https://github.com/archesproject/arches-docs) has its own issue ticketing system, so collecting to-do task in there is always good (they are plenty of them already!).

Adam

To view this discussion on the web visit https://groups.google.com/d/msgid/archesproject/BYAPR05MB6517EE8F27F9CBD91C33E35FDEBE0%40BYAPR05MB6517.namprd05.prod.outlook.com.

Angela Labrador

unread,

May 13, 2020, 4:38:46 PM5/13/20

to Adam Cox, Lily Pregill, Mahmoud Abdelrazek, Arches Project

Hi all,

I would be happy to pitch in on a documentation sprint! Count me in. :-)

Angela

To view this discussion on the web visit https://groups.google.com/d/msgid/archesproject/CAGYBTasNC4bVs5yaWOczviOE%2B5caQc%3DHbXKJymTjzdy6jsQF4g%40mail.gmail.com.

Neil Silberman

unread,

May 13, 2020, 4:53:46 PM5/13/20

to Arches Project

I'll be happy to contribute. Way back in v3 we started to work on documentation, but now is definitely time to do a thorough job on v5. I'm ready to sprint...

Best,

Neil

-- To post, send email to arches...@googlegroups.com. To unsubscribe, send email to arches...@googlegroups.com. For more information, visit https://groups.google.com/d/forum/archesproject?hl=en

---
You received this message because you are subscribed to the Google Groups "Arches Project" group.

To unsubscribe from this group and stop receiving emails from it, send an email to arches...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/archesproject/6749807d-07b4-43e4-b5ca-f76dc059d0c8%40googlegroups.com.

CAUTION: This email originated from outside of the Getty. Do not click links or open attachments unless you verify the sender and know the content is safe.

--
-- To post, send email to arches...@googlegroups.com. To unsubscribe, send email to arches...@googlegroups.com. For more information, visit https://groups.google.com/d/forum/archesproject?hl=en

---
You received this message because you are subscribed to the Google Groups "Arches Project" group.

To unsubscribe from this group and stop receiving emails from it, send an email to arches...@googlegroups.com.

Alina Myklebust

unread,

May 15, 2020, 7:25:53 PM5/15/20

to Arches Project

Hello everyone,

It's great to hear there is interest to structure and improve documentation for v5! Thanks Adam for suggesting a co-coordinated group effort to make it happen.

At this time, I'm aware of nearly a dozen projects currently in the process of installing/implementing Version 5. It would be great to see a few more users/implementors contribute some time to this effort! If you are currently working on v5, are you interested and willing to join Adam, Angela and Neil in a documentation sprint?? As I've heard many times the past years, good documentation is one of the single most valuable resources for implementors and developers. Thank you for your consideration!

All the best,

Alina

Dennis Wuthrich

unread,

May 16, 2020, 12:37:54 PM5/16/20

to Angela Labrador, Adam Cox, Lily Pregill, Mahmoud Abdelrazek, Arches Project

Adam,

Thanks for suggesting a sprint to improve documentation for v5. Great idea!

I’m happy to participate as well.

-Dennis

Dennis Wuthrich
CEO Farallon Geographics | www.fargeo.com
601 Montgomery St, Suite 1095 | San Francisco, CA 94111
T 415 227 1140 | Cell 415 317 2771

To view this discussion on the web visit https://groups.google.com/d/msgid/archesproject/CAJ1rquiB0tqhR9AsHiVw8CJBXCBcLc87298unPsO7D8Z-pZrmg%40mail.gmail.com.

Lily Pregill

unread,

May 18, 2020, 1:03:44 AM5/18/20

to Dennis Wuthrich, Angela Labrador, Adam Cox, Mahmoud Abdelrazek, Arches Project

Hi Adam,

Thanks for the great suggestion. I'm in, too!

Best,

Lily

From: Dennis Wuthrich <dwut...@fargeo.com>
Sent: Saturday, May 16, 2020 9:37 AM
To: Angela Labrador <ala...@gmail.com>
Cc: Adam Cox <mr.ad...@gmail.com>; Lily Pregill <LPre...@getty.edu>; Mahmoud Abdelrazek <raz...@gmail.com>; Arches Project <arches...@googlegroups.com>
Subject: Re: [Arches] v5 documentation

Adam Cox

unread,

Jun 4, 2020, 12:12:04 PM6/4/20

to Arches Project

Hi all, very happy to see so much interest.

Angela has reached out to me and said she is happy to co-coordinate, so we will begin moving forward.

I think a good way to start will be to open up a new thread here on the forum to call for community feedback: What have people found confusing in the documentation, What aspects are missing, etc. When we have a list of topics we can then see about divvying them up and asking for volunteers to help with each one.

Adam

On Monday, May 18, 2020 at 12:03:44 AM UTC-5, Lily Pregill wrote:

Hi Adam,

Thanks for the great suggestion. I'm in, too!

Best,

Lily

From: Dennis Wuthrich <dwut...@fargeo.com>
Sent: Saturday, May 16, 2020 9:37 AM
To: Angela Labrador <ala...@gmail.com>

Cc: Adam Cox <mr.ad...@gmail.com>; Lily Pregill <LPre...@getty.edu>; Mahmoud Abdelrazek <raz...@gmail.com>; Arches Project <archesproject@googlegroups.com>

Subject: Re: [Arches] v5 documentation

Adam,

Thanks for suggesting a sprint to improve documentation for v5. Great idea!

I’m happy to participate as well.

-Dennis

Dennis Wuthrich
CEO Farallon Geographics | www.fargeo.com
601 Montgomery St, Suite 1095 | San Francisco, CA 94111
T 415 227 1140 | Cell 415 317 2771

On May 13, 2020, at 1:38 PM, Angela Labrador <ala...@gmail.com> wrote:

Hi all,

I would be happy to pitch in on a documentation sprint! Count me in. :-)

Angela

On Wed, May 13, 2020 at 1:52 PM Adam Cox <mr.ad...@gmail.com> wrote:

Hi Lily and Mahmoud, really, you're both right. A little of the structural work to set the documentation version to 5 has been done (as Mahmoud pointed out), however, to my knowledge there has been no concerted effort since the release of v5 to actually update the documentation in a holistic manner--just bits and pieces like software requirements, etc. I think a few days of a coordinated "documentation sprint" would go a really long way toward fixing that. I would be happy to play some sort of role in such an effort, because it would benefit the community hugely (obviously), but can't commit at this time to fully coordinating it... perhaps co-coordinating.

If others are interested in contributing their time or resources, I think we should use this thread to begin planning. I will also note that the documentation repo (https://github.com/archesproject/arches-docs) has its own issue ticketing system, so collecting to-do task in there is always good (they are plenty of them already!).

Adam

On Tue, May 12, 2020 at 2:31 PM Lily Pregill <LPre...@getty.edu> wrote:

Thanks Mahmoud! I was looking at: https://arches.readthedocs.io/en/stable/overview/ and the version says 4.4.1.

On the v5 version, the page title of the Overview page reads "Overview 4.4.1" so something to fix.

best,

Lily

From: arches...@googlegroups.com <archesproject@googlegroups.com> on behalf of Mahmoud Abdelrazek <raz...@gmail.com>

Sent: Tuesday, May 12, 2020 12:11 PM

To: Arches Project <archesproject@googlegroups.com>

Subject: [Arches] Re: v5 documentation

Hi Lily,

I am not sure if this is what you are looking for, but here is a link to v5 documentation https://arches.readthedocs.io/en/5.0.0/

Best regards,

Mahmoud

On Tuesday, May 12, 2020 at 8:55:21 PM UTC+2, Lily Pregill wrote:

Hello,

Does anyone know if the current documentation has been updated for v5? The version history does not reflect v5:

v4.4 February, 2019: Release of Arches Collector mobile data collection app

v4.0 July, 2017: Significant site redesign, addition of graph creation UI, system settings UI, internal tileserver (TileStache), updated dependencies (MapBox GL, ElasticSearch 5.2, Yarn)

v3.0 April, 2015: Updated architecture, inclusion of the Reference Data Manager, updated dependencies (ElasticSearch, OpenLayers, Knockout)

v2.0 March, 2014: Improved upload of digital files, assorted bug fixes

v1.0 October, 2013: Initial Release

Thanks,

Lily

Lily Pregill, Systems Architect | The J. Paul Getty Trust | (310) 440 6394 | getty.edu

--

-- To post, send email to arches...@googlegroups.com. To unsubscribe, send email to archesproject+unsubscribe@googlegroups.com. For more information, visit https://groups.google.com/d/forum/archesproject?hl=en

---
You received this message because you are subscribed to the Google Groups "Arches Project" group.

To unsubscribe from this group and stop receiving emails from it, send an email to archesproject+unsubscribe@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/archesproject/6749807d-07b4-43e4-b5ca-f76dc059d0c8%40googlegroups.com.

CAUTION: This email originated from outside of the Getty. Do not click links or open attachments unless you verify the sender and know the content is safe.

--
-- To post, send email to arches...@googlegroups.com. To unsubscribe, send email to archesproject+unsubscribe@googlegroups.com. For more information, visit https://groups.google.com/d/forum/archesproject?hl=en

---
You received this message because you are subscribed to the Google Groups "Arches Project" group.

To unsubscribe from this group and stop receiving emails from it, send an email to archesproject+unsubscribe@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/archesproject/BYAPR05MB6517EE8F27F9CBD91C33E35FDEBE0%40BYAPR05MB6517.namprd05.prod.outlook.com.

--
-- To post, send email to arches...@googlegroups.com. To unsubscribe, send email to archesproject+unsubscribe@googlegroups.com. For more information, visit https://groups.google.com/d/forum/archesproject?hl=en

---
You received this message because you are subscribed to the Google Groups "Arches Project" group.

To unsubscribe from this group and stop receiving emails from it, send an email to archesproject+unsubscribe@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/archesproject/CAGYBTasNC4bVs5yaWOczviOE%2B5caQc%3DHbXKJymTjzdy6jsQF4g%40mail.gmail.com.

--
-- To post, send email to arches...@googlegroups.com. To unsubscribe, send email to archesproject+unsubscribe@googlegroups.com. For more information, visit https://groups.google.com/d/forum/archesproject?hl=en

---
You received this message because you are subscribed to the Google Groups "Arches Project" group.

To unsubscribe from this group and stop receiving emails from it, send an email to archesproject+unsubscribe@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/archesproject/CAJ1rquiB0tqhR9AsHiVw8CJBXCBcLc87298unPsO7D8Z-pZrmg%40mail.gmail.com.

Reply all

Reply to author

Forward