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

Improved onboarding process #528

Merged
merged 15 commits into from
Feb 3, 2022
Merged

Improved onboarding process #528

merged 15 commits into from
Feb 3, 2022

Conversation

idomic
Copy link
Contributor

@idomic idomic commented Feb 2, 2022

No description provided.

README.md Outdated Show resolved Hide resolved
doc/get-started/quick-start.rst Outdated Show resolved Hide resolved
--------------

.. code-block:: console
# ML pipeline example
Copy link
Contributor

Choose a reason for hiding this comment

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

this wont render well, it needs an empty line, the other code blocks need it as well

doc/get-started/quick-start.rst Outdated Show resolved Hide resolved
************

Depends what you want to achieve:
* **Bring your own code!** Check out the tutorial to [migrate your code to Ploomber](https://docs.ploomber.io/en/latest/user-guide/refactoring.html).
Copy link
Contributor

Choose a reason for hiding this comment

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

add relative paths, otherwise this will redirect users to a specific version of the documentation if they click on it (check out other rst files where we use the :doc: directive

@edublancas edublancas merged commit f5a800f into master Feb 3, 2022
@edublancas edublancas deleted the onboarding_fix branch February 3, 2022 00:58
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.

2 participants