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

docs: add clarity to versioning behavior #7327

Merged
merged 1 commit into from
May 4, 2022

Conversation

pepopowitz
Copy link
Contributor

@pepopowitz pepopowitz commented May 4, 2022

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

This PR attempts to add a bit of clarity around the source folders & web URLs for versioning behavior.

I was trying to understand how Docusaurus itself handles versions, as our Camunda docs handle it slightly differently, and I struggled a bit trying to connect all the dots for these lines. This is a very minor docs update, but I thought specifying the source folders & web URLs for both described versions would add clarity.

I chose to not add the changes to older versioned docs because it was so minor.

Test Plan

No test plan for this minor update to doc verbiage.

Test links

Deploy preview: https://deploy-preview-7327--docusaurus-2.netlify.app/docs/versioning/#configuring-versioning-behavior

Related issues/PRs

None that I could find.

@facebook-github-bot
Copy link
Contributor

Hi @pepopowitz!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@netlify
Copy link

netlify bot commented May 4, 2022

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 8486adc
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/62729f86028d340008dab2be
😎 Deploy Preview https://deploy-preview-7327--docusaurus-2.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.

@github-actions
Copy link

github-actions bot commented May 4, 2022

⚡️ Lighthouse report for the changes in this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🔴 41 🟢 100 🟢 100 🟢 100 🟢 90 View report
/docs/installation 🟠 80 🟢 96 🟢 100 🟢 100 🟢 90 View report

Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Thanks! I can see how it makes the description clearer. If it helps you understand better, I'm sure it will help others as well.

@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label May 4, 2022
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label May 4, 2022
@Josh-Cena Josh-Cena merged commit 9ead309 into facebook:main May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants