Skip to content

Clarify local dev doc source#48

Merged
branchv merged 1 commit intopython-poetry:mainfrom
juhoautio:doc_local_dev
Aug 4, 2022
Merged

Clarify local dev doc source#48
branchv merged 1 commit intopython-poetry:mainfrom
juhoautio:doc_local_dev

Conversation

@juhoautio
Copy link
Copy Markdown
Contributor

I was confused because I expected to find a sparse checkout under content/docs, with the ability to interact with poetry repo with git commands.

What actually happens is that a sparse checkout is made only temporary in a temporary folder, and the plain files are copied from the temporary folder to content/docs.

For the reader of the this doc it doesn't matter how the .md files are fetched from poetry repo. Using sparse checkout is just an internal choice of the bin/website script.


Side note: IMHO it would be nice to document a single command that allows pointing to a local folder (typically ../poetry/docs) as an alternative to fetching from the public poetry repo. This would be handy in the use case where I have myself cloned poetry repo for local development, and am working on some doc changes among poetry code changes. If I can do something to make that happen, please let me know.

Copy link
Copy Markdown
Member

@branchv branchv left a comment

Choose a reason for hiding this comment

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

agreed, thanks a lot for updating this!

Side note: IMHO it would be nice to document a single command that allows pointing to a local folder

Absolutely, I'll add something to optionally symlink a local directory

@branchv branchv added the safe label Aug 4, 2022
@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 4, 2022

Deploy preview for website ready!

✅ Preview
https://website-4vce7c5jd-python-poetry.vercel.app

Built with commit 0abb568.
This pull request is being automatically deployed with vercel-action

@branchv branchv merged commit fa20c93 into python-poetry:main Aug 4, 2022
@radoering radoering removed the safe label Mar 2, 2026
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.

3 participants