You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I was following the getting started instructions for sphinx and ran into an issue with the Makefile.
The instructions seem to assume that the Starter Pack is installed, but only the sphinx package is installed, so there is no Makefile.
I am happy to write a PR to fix this, but I wanted to check with you to see what the desired workflow is. I would think that you would want a workflow something like:
clone the starter pack
cd into the starter pack
build and server the starter pack samples
copy some of the .rst or .md files from the multipass, snapcraft, or wsl folders from the open-documentation-academy repo into the starter pack folder
add the new folder(s) to index.rst
make build and examine the structure under the build folder
make serve
Does this sound correct?
The text was updated successfully, but these errors were encountered:
@DanRoscigno Thank you so much for suggesting this, and I'm sorry for not responding before now. We've just discussed this briefly, and you're more than welcome to try and improve the getting started instructions.
degville
added
size 2
Fix a known documentation issue (size 2/8)
update
Update potentially outdated instructions, commands, or version numbers
labels
Sep 13, 2024
Hi @DanRoscigno , I monitor Multipass-related issues and saw your PR: #140 - I think it's a great idea suggesting to use Multipass if you don't have a Linux machine available :) I'll check progress to see how things are working out!
Hi @DanRoscigno , I monitor Multipass-related issues and saw your PR: #140 - I think it's a great idea suggesting to use Multipass if you don't have a Linux machine available :) I'll check progress to see how things are working out!
Thanks @giuliazanchi , I use multipass or Docker for things like this even though I run on Linux. This ensures that when I write a HowTo I am starting off form the same point as the reader.
I was following the getting started instructions for
sphinx
and ran into an issue with the Makefile.The instructions seem to assume that the Starter Pack is installed, but only the
sphinx
package is installed, so there is no Makefile.I am happy to write a PR to fix this, but I wanted to check with you to see what the desired workflow is. I would think that you would want a workflow something like:
.rst
or.md
files from themultipass
,snapcraft
, orwsl
folders from theopen-documentation-academy
repo into the starter pack folderindex.rst
Does this sound correct?
The text was updated successfully, but these errors were encountered: