project-chip / matter-handbook

This is the repoository for the Matter Handbook, content is published at https://handbook.buildwithmatter.com
Creative Commons Attribution 4.0 International
11 stars 11 forks source link

Correct grammar, hyperlinks and formatting #17

Closed ipadurean-bd closed 3 months ago

ipadurean-bd commented 4 months ago

Correct acronym defined first for each document Use Alliance instead of CSA (two terms: Alliance and CSA were used for the Connectivity Standard Alliance) Correct grammar mistakes Correct the hyperlinks Correct formatting Apply uniform formatting of lists with dot at the end

CLAassistant commented 4 months ago

CLA assistant check
All committers have signed the CLA.

sammachin commented 4 months ago

@ipadurean-bd thanks for the contribution,

We don't use the acronym CSA we prefer "The Alliance" as a shortened term. Other fixes look good, could you update your PR to remove the CSA changes

ipadurean-bd commented 4 months ago

@sammachin thank you! I updated the PR so it contains the preferred shortened term

ipadurean-bd commented 4 months ago

@sammachin I see the Deploy PR previews keep failing. Is there anything I should change to the PR?

sammachin commented 4 months ago

@ipadurean-bd yeah I thought I'd fixed that yesterday, but your's is the first PR using it that's coming from an external repo so I can see its still failing. I'll take a look at that today,

sammachin commented 4 months ago

@ipadurean-bd I think I've found the issue, could you fetch the latest changes into your fork and it should then run, it was using the variables and secrets from your fork rather than the main repo

github-actions[bot] commented 4 months ago

Preview deployed at https://d1teub3jrrfss6.cloudfront.net/pr-17

ipadurean-bd commented 4 months ago

@sammachin done

sammachin commented 4 months ago

seems like the action was still checking out the main branch not your head, I've just updated it so could you fetch that change and we'll see what it builds this time

github-actions[bot] commented 4 months ago

Preview deployed at https://d1teub3jrrfss6.cloudfront.net/pr-17

ipadurean-bd commented 3 months ago

@sammachin what is the situation on this pull request? It cannot be merged?

sammachin commented 3 months ago

@ipadurean-bd could you pull in the latest changes from main, that should trigger the preview to be re-deployed, there were some bugs in the github action used for the previews but it was also running the action in main and showing that as the preview without your changes! I also commented above that the change to /static for images is wrong, the handbook isn't meant to be read from github this is just the source for the static site generated with hugo and published at https://handbook.buildwithmatter.com

github-actions[bot] commented 3 months ago

Preview deployed at https://d1teub3jrrfss6.cloudfront.net/pr-17

ipadurean-bd commented 3 months ago

@sammachin so I should revert the images changes?

sammachin commented 3 months ago

@sammachin so I should revert the images changes?

Yes please, as you can now see in the preview the images don't load https://d1teub3jrrfss6.cloudfront.net/pr-17/howitworks/datamodel/

github-actions[bot] commented 3 months ago

Preview deployed at https://d1teub3jrrfss6.cloudfront.net/pr-17

github-actions[bot] commented 3 months ago

Preview deployed at https://d1teub3jrrfss6.cloudfront.net/pr-17

ipadurean-bd commented 3 months ago

@sammachin I reverted the hyperlinks, but the preview still doesn't load the images

sammachin commented 3 months ago

@sammachin I reverted the hyperlinks, but the preview still doesn't load the images

ah I think that might be the cloudfront preview caching the previous pages, 2 mins I'll take a look

sammachin commented 3 months ago

yes it was the caching, I'll need to add an invalidation to the action in future,

Thanks I'll review the rest of the edits today

github-actions[bot] commented 3 months ago

Preview deployed at https://d1teub3jrrfss6.cloudfront.net/pr-17

sammachin commented 3 months ago

thanks all looks good/

github-actions[bot] commented 3 months ago

Preview deployed at https://d1teub3jrrfss6.cloudfront.net/pr-17