Skip to content

Conversation

@rudokemper
Copy link
Member

Closes #3. Closes #18.

I went back and forth on whether these should be "Guides" instead of pages in "Reference". But grounded in https://diataxis.fr/, I felt that the content I was creating was still moreso the latter.

I think we can also add pages for these issues in "Common Workflows":

As I was putting this together, it occurred to me that we sometimes write for different user personas. And maybe one thing we can do is clarify that explicitly at the top of each page. So as to communicate, for example, "this page is intended for a community organization's technical data manager". Could be nice to have a page where we define each, and then refer back to that page for definitions across the platform.

Thoughts welcome! (Both on this latter point, and "Common Workflows")

Copy link
Contributor

@nicopace nicopace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good!
Just small comment on the Windmill scripts' use.

Comment on lines +25 to +33
Use the `postgres_to_geojson` script in the [GC Scripts Hub](/reference/gc-toolkit/gc-scripts-hub/) to export spatial data:

1. **Access GC Scripts Hub**: Navigate to your Guardian Connector instance
2. **Run the export script**:
- Select the `postgres_to_geojson` script
- Choose your database connection
- Specify the table containing spatial data
- Set the export path (default: `/persistent-storage/datalake/exports`)
3. **Download the file**: Use [Filebrowser](/reference/gc-toolkit/filebrowser/) to download the generated GeoJSON file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is any of this user-facing interactions?
I like the idea of self-service, but at least as I imagine it, I can't foresee them going into Windmill to run a gc-scripts-hub script.
In any of our users exposed to this? If so, would love to know more so we can add a complementary guide to Windmill.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. I think we do need to add a reference document about using Windmill as an Operator user. That is in fact the intention, but we don't have it in docs yet.

But users will need to log in and access Windmill in the future, even to do things like use the GC Uploader App. (We won't want to expose that to the public, lest anyone can upload a file to an instance without authentication.)

So this copy here does reflect what will need to happen, but we're missing the overall "How to use Windmill" reference.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I filed an issue for this: #60

@rudokemper rudokemper merged commit 61ad0b1 into main Sep 11, 2025
@rudokemper rudokemper deleted the common-workflows branch September 11, 2025 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants