graphql-engine icon indicating copy to clipboard operation
graphql-engine copied to clipboard

Docs-update screenshots close #8883

Open Ln11211 opened this issue 1 year ago • 5 comments

Description

Updated the outdated screenshots of docs. This PR is work in progress...

Changelog

Component : server / cli / console / build

Type: bugfix / feature / enhancement

Product: community-edition

Short Changelog

Long Changelog

Related Issues

The related issue is #8883

Solution and Design

Steps to test and verify

Limitations, known bugs & workarounds

Server checklist

Catalog upgrade

Does this PR change Hasura Catalog version?

  • [ ] No
  • [ ] Yes
    • [ ] Updated docs with SQL for downgrading the catalog

Metadata

Does this PR add a new Metadata feature?

  • [ ] No
  • [ ] Yes
    • Does run_sql auto manages the new metadata through schema diffing?
      • [ ] Yes
      • [ ] Not required
    • Does run_sql auto manages the definitions of metadata on renaming?
      • [ ] Yes
      • [ ] Not required
    • Does export_metadata/replace_metadata supports the new metadata added?
      • [ ] Yes
      • [ ] Not required

GraphQL

  • [ ] No new GraphQL schema is generated
  • [ ] New GraphQL schema is being generated:
    • [ ] New types and typenames are correlated

Breaking changes

  • [ ] No Breaking changes

  • [ ] There are breaking changes:

    1. Metadata API

      Existing query types:

      • [ ] Modify args payload which is not backward compatible
      • [ ] Behavioural change of the API
      • [ ] Change in response JSON schema
      • [ ] Change in error code
    2. GraphQL API

      Schema Generation:

      • [ ] Change in any NamedType
      • [ ] Change in table field names

      Schema Resolve:-

      • [ ] Change in treatment of null value for any input fields
    3. Logging

      • [ ] Log JSON schema has changed
      • [ ] Log type names have changed

Ln11211 avatar Oct 07 '22 11:10 Ln11211

Beep boop! :robot:

Hey @Ln11211, thanks for your PR!

One of my human friends will review this PR and get back to you as soon as possible.

Stay awesome! :sunglasses:

hasura-bot avatar Oct 07 '22 11:10 hasura-bot

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Oct 07 '22 11:10 CLAassistant

This PR is a work in progress. Updated the screenshots of the following docs until now-

  • docker-simple.mdx (4 ss)

Ln11211 avatar Oct 07 '22 11:10 Ln11211

Hey @Ln11211 - just checking in since you've marked these as WIP...any progress or desire for review yet? Thanks!

robertjdominguez avatar Oct 17 '22 19:10 robertjdominguez

hello there, I'll be uploading more docs soon, I'll ping you as soon as I commit them :-)

Ln11211 avatar Oct 18 '22 01:10 Ln11211

  • [x] getting-started/docker-simple
  • [x] schema/postgres/tables
  • [x] schema/postgres/table-relationships/create
  • [x] schema/postgres/remote-relationships/remote-source-relationships
  • [x] schema/postgres/remote-relationships/remote-schema-relationships
  • [ ] schema/postgres/remote-relationships/action-relationships
  • [x] schema/postgres/views
  • [x] schema/postgres/custom-functions
  • [x] schema/postgres/default-values/postgres-defaults
  • [x] schema/postgres/default-values/sql-functions
  • [x] schema/postgres/default-values/column-presets
  • [x] schema/postgres/default-values/created-updated-timestamps
  • [x] schema/postgres/enums
  • [ ] schema/postgres/computed-fields
  • [x] schema/postgres/custom-field-names
  • [x] schema/postgres/naming-convention
  • [x] schema/postgres/data-validations
  • [x] 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
  • [ ] 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

Ln11211 avatar Oct 23 '22 04:10 Ln11211

hello @robertjdominguez, I hope you are doing good, I have updated the screenshots for the UI in the schema/postgres docs, could you please check them all while I start with the schema/ms-sql-server docs (see the check list in the top ^^) .

NOTE : I am using the previous names for the screenshots so that way I would only need to change the image files and not the src tag in the documentation. This saves me some time when I update the images. Please do let me know if I have to change any images.

Ln11211 avatar Oct 23 '22 10:10 Ln11211

image

Hey @robertjdominguez , this branch is 67 commits behind the master branch and I can't merge the commits automatically, can I go ahead and create a pr in my repo to merge those commits ?

Ln11211 avatar Oct 23 '22 11:10 Ln11211

Hey @robertjdominguez , this branch is 67 commits behind the master branch and I can't merge the commits automatically, can I go ahead and create a pr in my repo to merge those commits ?

Hi @Ln11211 👋

You won't be able to merge yourself; our CI processes will take care of that if the PR is approved. I've had a chance to look over this; you've done a lot of work and we thank you for that! 🥳

I do have some feedback that may make it difficult, depending on how you've completed these screenshots, to reconcile:

Our wiki, which is linked in the original issue, makes note that we use a very specific hex value for our callouts (arrows, boxes, etc.). Your screenshots utilize #fa4a42 while we require #fc336d. It's subtle, but there's a difference.

Would you be willing to update your work?

robertjdominguez avatar Oct 24 '22 16:10 robertjdominguez

You won't be able to merge yourself; our CI processes will take care of that if the PR is approved. I've had a chance to look over this; you've done a lot of work and we thank you for that! 🥳

no no not merge this PR, I want to merge the commits to this branch, I am behind the original tree I mean I still have the docs-old with me

Our wiki, which is linked in the original issue, makes note that we use a very specific hex value for our callouts (arrows, boxes, etc.). Your screenshots utilize #fa4a42 while we require #fc336d. It's subtle, but there's a difference.

Would you be willing to update your work?

Yes yes, I'll change them.

Ln11211 avatar Oct 24 '22 16:10 Ln11211

You should be able to run git merge master from your branch and resolve any conflicts.

robertjdominguez avatar Oct 24 '22 17:10 robertjdominguez

Hey @robertjdominguez , I changed the hex values of the arrows and boxes but I have many conflicts, I resolved the conflicts but I have about 164 commits(that I have to push to my branch), I thin I will break the master branch so, Can I please close this PR and raise a new one?

image

Ln11211 avatar Oct 31 '22 14:10 Ln11211

If it's easiest for you to open a new PR, @Ln11211 then please do so 👍

robertjdominguez avatar Oct 31 '22 14:10 robertjdominguez

If it's easiest for you to open a new PR, @Ln11211 then please do so 👍

I apologize for messing my working branch :/

Ln11211 avatar Oct 31 '22 14:10 Ln11211