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

draft: docs: Transfer Unit docs #171

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

draft: docs: Transfer Unit docs #171

wants to merge 6 commits into from

Conversation

JTorreG
Copy link
Contributor

@JTorreG JTorreG commented Feb 6, 2025

To-do: Transfer pre-2023 news and release notes.

Proposed changes

  • Transfer the NGINX Unit documentation to the documentation repository
  • Convert the content from sphinx to Hugo

Note: The scope of this PR is to move the existing content and make sure that it renders properly with Hugo's features (and limitations). Updating the content and IA to follow NGINX guidelines is a separate effort outside of scope.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • I have updated any relevant documentation (README.md and CHANGELOG.md)
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.

Please refer to our style guide for guidance about placeholder content.

@JTorreG JTorreG self-assigned this Feb 6, 2025
@JTorreG JTorreG requested a review from a team as a code owner February 6, 2025 19:03
Copy link

github-actions bot commented Feb 6, 2025

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/171/

@JTorreG JTorreG marked this pull request as draft February 6, 2025 19:07
Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

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

The content seems fine based on a visual "spot check" diff of a few files. (As noted in the description, this change also included a conversion from rST -> Markdown, so normal "diff" tools would not work)

@Jcahilltorre , the build doesn't work. As shown in the screenshot, whenever I build locally (or use the "frontdoor" build at https://frontdoor-test-docs.nginx.com/previews/docs/171/),

And then point to the NGINX Unit card, I get a direct link to https://unit.nginx.org.

  • My guess: the link is "hard coded" somewhere.

But then @Jcahilltorre pointed me to https://frontdoor-test-docs.nginx.com/previews/docs/171/nginx-unit

Jon, I'm approving. Just make sure the link works from the docs.nginx.com front page after merge.

Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

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

Based on other discussion in this PR

@thresheek
Copy link
Member

I've noticed a few issues with the content.

  1. Seems like the intructions in "2. Install the core package and other packages you need" are broken in the converted site over at https://frontdoor-test-docs.nginx.com/previews/docs/171/unit/installation/#installation-precomp-amazon:
    image Compared to https://unit.nginx.org/installation/#amazon-linux there's an extra "``` console" part.

  2. Copying a command from the step inserts "#" to the paste buffer. E.g. for the following block:
    image when you click "Copy", I see # systemctl restart unit # Necessary for Unit to pick up any changes in language module setup in the paste buffer. On the current site, just systemctl restart unit is getting copied to the paste buffer. This renders copy functionality less useful and will result in errors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants