Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Folderize Docs: Each topic gets a folder #4514

Merged
merged 4 commits into from
Dec 17, 2022
Merged

Folderize Docs: Each topic gets a folder #4514

merged 4 commits into from
Dec 17, 2022

Conversation

herostrat
Copy link
Contributor

Mirrors the structure on the webpage. I find it easier to find things.

@netlify
Copy link

netlify bot commented Nov 25, 2022 •
edited
Loading

✅ Deploy Preview for frigate-docs ready!

Name Link
🔨 Latest commit 72d06bf
🔍 Latest deploy log https://app.netlify.com/sites/frigate-docs/deploys/639cb1b7fa17a70008a91df2
😎 Deploy Preview https://deploy-preview-4514--frigate-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@herostrat herostrat changed the base branch from dev to master November 25, 2022 18:16
@blakeblackshear
Copy link
Owner

Can you see the netlify logs? The build fails because of broken links.

@herostrat
Copy link
Contributor Author

herostrat commented Nov 28, 2022 •
edited
Loading

Can you see the netlify logs? The build fails because of broken links.

Yes, I should really mark things WIP in the future. I ran out on time to update all links.

@NickM-27 NickM-27 marked this pull request as draft December 6, 2022 00:07
@herostrat herostrat marked this pull request as ready for review December 7, 2022 20:09
@herostrat herostrat marked this pull request as draft December 7, 2022 20:11
@herostrat herostrat marked this pull request as ready for review December 7, 2022 20:14
@herostrat
Copy link
Contributor Author

Something seems to be broken with netlify. I cannot get the pipeline to run, there are no logs.
I think I fixed all broken links nonetheless.

@blakeblackshear
Copy link
Owner 

2:02:42 PM: Exhaustive list of all broken links found:
2:02:42 PM: 
2:02:42 PM: - On source page path = /configuration/rtmp:
2:02:42 PM:    -> linking to /faqs#audio-in-recordings (resolved as: /faqs)
2:02:42 PM: 
2:02:42 PM: - On source page path = /guides/getting_started:
2:02:42 PM:    -> linking to /installation
2:02:42 PM: 
2:02:42 PM: - On source page path = /troubleshooting/faqs:
2:02:42 PM:    -> linking to /installation#calculating-required-shm-size (resolved as: /installation)

@herostrat herostrat force-pushed the folderize_docs branch 2 times, most recently from 544f276 to fa6e2df Compare December 14, 2022 19:32
@herostrat
Copy link
Contributor Author

herostrat commented Dec 14, 2022 •
edited
Loading

My search regex was incomplete. Thanks for the log.
I thought one has to add the .md to the links.

I cannot few the logs of my new commits, where I tried to sync all links.
Does anyone know why I cannot see the netlify logs? I even logged in there...

herostrat
herostrat commented Dec 14, 2022
View reviewed changes
docs/docs/integrations/home-assistant.md
@@ -134,7 +134,7 @@ For advanced usecases, this behavior can be changed with the [RTMP URL
template](#options) option. When set, this string will override the default stream
address that is derived from the default behavior described above. This option supports
[jinja2 templates](https://jinja.palletsprojects.com/) and has the `camera` dict
variables from [Frigate API](https://blakeblackshear.github.io/frigate/usage/api#apiconfig)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This link was outdated (1/2)

herostrat
herostrat commented Dec 14, 2022
View reviewed changes
docs/docs/integrations/home-assistant.md
@@ -171,7 +171,7 @@ The Frigate integration seamlessly supports the use of multiple Frigate servers.
In order for multiple Frigate instances to function correctly, the
`topic_prefix` and `client_id` parameters must be set differently per server.
See [MQTT
configuration](https://blakeblackshear.github.io/frigate/configuration/index#mqtt)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This link was outdated (2/2)

@blakeblackshear
Copy link
Owner

npm run build should show you the same output

@blakeblackshear blakeblackshear merged commit e3e03ec into blakeblackshear:master Dec 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@herostrat @blakeblackshear