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

Updated get_started.md to separate Windows-specific steps and install_git.md to fix typos. #168

Merged
merged 1 commit into from
Feb 12, 2025

Conversation

bruce-esrig
Copy link
Contributor

Updated get_started.md to separate Windows-specific steps
Updated install_git.md to (i) point at images/clone_repo.png and (ii) provide the whole clone command, HTTP version, i.e.

git clone https://github.com/canonical/open-documentation-academy.git

Updated install_git.md to (i) point at images/clone_repo.png and
(ii) provide the whole clone command, HTTP version, ending with ....git
@bruce-esrig
Copy link
Contributor Author

TBDs that need prioritization ...

  • Select an established info set to compare the getting started info set with
  • Get local previewing to work ... by linking topics under ./docs ?
  • Describe possible OS install configurations
  • Describe Ubuntu-specific versioning (I'm on 24.04, how to remove version dependency when working through instructions)
  • Document the docs Makefile ... what states can it be in, what do those look like, and how to proceed (for example, letting Makefile run in its own Terminal window, versus putting it in the background
  • How to document builds ...
  • Make an annotated list of commands issued
  • For debugging individual steps, pipe standard output and standard error to a file
  • Specific to running an Ubuntu desktop in a virtual machine
  • Sharing a disk with the host machine
  • Path to the shared disk
  • A golden copy of the configuration records on the shared disk
  • Copying files to/from the shared disk without losing permissions and dates (for example, using tar)

See attached copy of .bashrc for details on linking to a shared disk from MacOS and from Ubuntu in a VM on MacOS
_bashrc_cp.txt

Copy link
Collaborator

@s-makin s-makin left a comment

Choose a reason for hiding this comment

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

This is great, it looks much better organised! And once we have some instructions for users on MacOS it will be much easier to fit them in so that they won't feel like an afterthought.

Thanks for also fixing the broken bits! This will provide a much nicer experience for people that need to use the git guide.

@s-makin s-makin merged commit eb37cf2 into canonical:main Feb 12, 2025
1 check passed
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