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.

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

Update macOS dev docs #16625

Merged
merged 9 commits into from
Sep 6, 2024
Merged

Update macOS dev docs #16625

merged 9 commits into from
Sep 6, 2024

Conversation

mrmir
Copy link
Contributor

@mrmir mrmir commented Sep 4, 2024

What are you trying to accomplish?

We're updating the dev docs to better reflect the current state of the OP installation on macOS.

The postgres install command has been changed a little and it now creates a DB instance by default. Also, a database connection flag needs to be added to prevent crashes, and steps to install java and imagemagick have been added.

Tobias Dillmann added 3 commits September 5, 2024 08:50
gssencmode: disabled is required, or else Ruby will crash :(
This will be required for OpenProject to fully work.

The hints to install these is there, but in other places of the docs.
I think it makes sense to add them here. Doesn't hurt to install
everything at once.
Unfortunately, we cannot update the headline, too. This would break
links.
@as-op
Copy link
Contributor

as-op commented Sep 5, 2024

Unfortunately, we cannot update the headline, too. This would break links.

Hi @EinLama, please feel free to change headlines as you see fit. :)

There is a Github action checking the links inside the markdown docs, so those anchor links can be easily adjusted.
If something is linked from the website to a changed docs anchor, there is another link checker detecting that.

You can also run the link check script locally with
$ script/docs/check_links

(Just renaming folder names would lead to different urls, that has to be handled with care and a note to me, so that I maybe can add redirects to the website.)

@as-op as-op removed the needs review label Sep 5, 2024
@as-op as-op self-requested a review September 5, 2024 08:56
@mrmir
Copy link
Contributor Author

mrmir commented Sep 5, 2024

Unfortunately, we cannot update the headline, too. This would break links.

Hi @EinLama, please feel free to change headlines as you see fit. :)

There is a Github action checking the links inside the markdown docs, so those anchor links can be easily adjusted. If something is linked from the website to a changed docs anchor, there is another link checker detecting that.

You can also run the link check script locally with $ script/docs/check_links

(Just renaming folder names would lead to different urls, that has to be handled with care and a note to me, so that I maybe can add redirects to the website.)

@EinLama This is okay to merge but I'm leaving it open as I don't know if you want to do something about the headlines.

@EinLama
Copy link
Contributor

EinLama commented Sep 5, 2024

Thank you, @mrmir and @as-op. Took the chance to adjust the headline 😉

@EinLama
Copy link
Contributor

EinLama commented Sep 6, 2024

I've added another commit with more info as discussed.

@as-op I followed the documentation style guide in order to insert a [!TIP] and hope I did it correctly.

Copy link
Contributor

@aaron-contreras aaron-contreras left a comment

Choose a reason for hiding this comment

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

Thanks for this!

@mrmir mrmir merged commit d4d6d59 into dev Sep 6, 2024
7 checks passed
@mrmir mrmir deleted the update-macos-developer-docs branch September 6, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

4 participants