docs: update screenshots

marionschleifer commented 2 years ago

Problem description

Screenshots have mostly been updated for Cloud related docs (identified by the ☁️ icon on docs) and for the Enterprise docs (identified by the 🏢 icon on docs).

A lot of the screenshots of the feature docs are outdated.

Describe the solution you'd like

Update the updated screenshots.

Instructions

Please read carefully through the Wiki on writing documentation, especially the images section.

Ln11211 commented 1 year ago

@marionschleifer I'm interested but can you tell me where do I get the screenshots from? and also which document/s you want me to update?

marionschleifer commented 1 year ago

@Ln11211 You get the screenshots by actually going through all the tutorials and then check if the UI has been changed. If so, you can create a new screenshot and add it to the docs. All pages except the Cloud and Enterprise docs need to be checked and updated (as explained in the description above). Hope that helps 🙂

sujithkdola commented 1 year ago

@marionschleifer I've read the documents and noticed that there are more than 50 screenshots that need to be updated; I'd like to be assigned to this Issue.

marionschleifer commented 1 year ago

@Sujithkumardola feel free to take this up, nobody has raised a PR on this so far 🙂

Ln11211 commented 1 year ago

@Ln11211 You get the screenshots by actually going through all the tutorials and then check if the UI has been changed. If so, you can create a new screenshot and add it to the docs. All pages except the Cloud and Enterprise docs need to be checked and updated (as explained in the description above). Hope that helps 🙂

Seems like a lot of reading to do :) I am interested and I'll do the task. Since @Sujithkumardola is also interested, how about we divide the work? is that ok with you @marionschleifer ? what say you @Sujithkumardola ?

Stefmore02 commented 1 year ago

Hey folks, thank you for your interest! Feel free to divide amongst yourselves, seems like a good idea.

sujithkdola commented 1 year ago

@Ln11211 That sounds good.

Ln11211 commented 1 year ago

Hello @Stefmore02, I have read the wiki for adding the images in which it is specified that a 1200px viewport for images and also a naming convention for the images and I followed them.

I raised a PR now, so that you can review the changes I did for a file docker-simple.mdx and let me know if I am doing them correctly.

I also wanted to know about the recommended editor for editing the .mdx extensions, I use intelliJ and it has got no plugin or support for .mdx, so I don't get the preview for the changes I make, any help please ? :)

Ln11211 commented 1 year ago

@Sujithkumardola Looks like all the docs except the cloud and enterprise need a review and update, I'll list them out here and strike out the one's that are already done(so that we don't repeat), feel free to add to the list and pick some from the list...

**Feel free to strike off if the ss are already up to date

[x] getting-started/docker-simple
[x] databases/connect-db/index
[x] databases/connect-db/read-replicas
[x] databases/postgres/citus-hyperscale-postgres/getting-started/cloud
[x] databases/postgres/citus-hyperscale-postgres/getting-started/docker
[x] databases/ms-sql-server/getting-started/cloud
[x] databases/ms-sql-server/getting-started/docker
[x] databases/bigquery/getting-started/cloud
[x] databases/bigquery/getting-started/docker
[ ] schema/postgres/tables
[ ] schema/postgres/table-relationships/create
[ ] schema/postgres/remote-relationships/remote-source-relationships
[ ] schema/postgres/remote-relationships/remote-schema-relationships
[ ] schema/postgres/remote-relationships/action-relationships
[ ] schema/postgres/views
[ ] schema/postgres/custom-functions
[ ] schema/postgres/default-values/postgres-defaults
[ ] schema/postgres/default-values/sql-functions
[ ] schema/postgres/default-values/column-presets
[ ] schema/postgres/default-values/created-updated-timestamps
[ ] schema/postgres/enums
[ ] schema/postgres/computed-fields
[ ] schema/postgres/custom-field-names
[ ] schema/postgres/naming-convention
[ ] schema/postgres/data-validations
[ ] schema/postgres/using-existing-database (this page is missing photos although it should have photos for the console)
[ ] schema/postgres/relay-schema
[ ] schema/ms-sql-server/tables
[ ] schema/ms-sql-server/table-relationships/create
[ ] schema/ms-sql-server/remote-relationships/remote-source-relationships
[ ] schema/ms-sql-server/views
[ ] schema/ms-sql-server/default-values/mssql-defaults
[ ] schema/ms-sql-server/default-values/mssql-column-presets
[ ] schema/ms-sql-server/using-existing-database (this page is missing photos although it should have photos for the console)
[ ] schema/bigquery/tables
[ ] schema/bigquery/custom-field-names (needs attention!!, @Stefmore02 can check this out? )
[ ] schema/bigquery/table-relationships/create
[ ] schema/bigquery/remote-relationships/remote-source-relationships
[ ] schema/bigquery/remote-relationships/remote-schema-relationships
[ ] schema/bigquery/computed-fields
[ ] schema/bigquery/data-validations

The above checkboxes are the pages that need ss update. well @Sujithkumardola, if you feel lost just know that the above check boxes are the path and the last part is the actual file that needs the change, so for instance- schema/postgres/enums means the enums file in the postgres directory needs a ss update..

Step1- Setup Hasura at your end Step2- open the file in the Hasura docs https://hasura.io/docs/latest/index/ Step3- open the same file in the source code Step4- Follow the onscreen doc (if the docs say create a table, create a database, create them) Step5- Compare the docs with your screen and take screenshots and update :)

Ln11211 commented 1 year ago

Once you pick your docs, create a comment and paste your list and strike them off from the above, that way we can stay organized.

Ln11211 commented 1 year ago

@Sujithkumardola Looks like all the docs except the cloud and enterprise need a review and update, I'll list them out here and strike out the one's that are already done(so that we don't repeat), feel free to add to the list and pick some from the list...

**Feel free to strike off if the ss are already up to date

[x] getting-started/docker-simple

[ ] databases/connect-db/index

[ ] databases/connect-db/read-replicas

Btw @marionschleifer and @Sujithkumardola , I apologize if you keep getting pinged as I update this list, I just want to have everything at one place, hope you understand :)

sujithkdola commented 1 year ago

[x] databases/connect-db/index
[ ] databases/connect-db/read-replicas > available only on cloud
[x] databases/postgres/citus-hyperscale-postgres/getting-started/cloud
[x] databases/postgres/citus-hyperscale-postgres/getting-started/docker
[x] databases/ms-sql-server/getting-started/cloud
[x] databases/ms-sql-server/getting-started/docker
[x] databases/bigquery/getting-started/cloud
[x] databases/bigquery/getting-started/docker

Completed Updating the Databases Section. I'll make a PR shortly

sujithkdola commented 1 year ago

Hello @Stefmore02, I have read the wiki for adding the images in which it is specified that a 1200px viewport for images and also a naming convention for the images and I followed them.

I raised a PR now, so that you can review the changes I did for a file docker-simple.mdx and let me know if I am doing them correctly.

I also wanted to know about the recommended editor for editing the .mdx extensions, I use intelliJ and it has got no plugin or support for .mdx, so I don't get the preview for the changes I make, any help please ? :)

hey @Ln11211

Have a look at this Extension.

seanparkross commented 1 year ago

@Ln11211 Just checked out the PR and it looks good thanks!

One comment... please crop out your browser UI scroll bars.

Thanks Sean

hasura / graphql-engine