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

Add a 'how do I...' section into docs #1953

Merged
merged 11 commits into from
Oct 23, 2023
Merged

Conversation

strickvl
Copy link
Contributor

Adds a section with pointers to documentation for commonly-asked questions.

(Also (re)-adds the dependency clashes documentation + removes (unpublished) NLP project template link from docs.)

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • If I have added an integration, I have updated the integrations table and the corresponding website section.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

@strickvl strickvl added documentation Improvements or additions to documentation internal To filter out internal PRs and issues labels Oct 17, 2023
Copy link
Contributor

@fa9r fa9r left a comment

Choose a reason for hiding this comment

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

Two very nice pages, let's get them live 🙌

docs/book/reference/how-do-i.md Outdated Show resolved Hide resolved
docs/book/reference/how-do-i.md Show resolved Hide resolved
docs/book/reference/how-do-i.md Outdated Show resolved Hide resolved
@strickvl strickvl merged commit 0edb8fe into develop Oct 23, 2023
4 checks passed
@strickvl strickvl deleted the doc/OSS-2486-how-do-i-docs branch October 23, 2023 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants