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

WIP: add x86 image documentation, close #710 #711

Closed
wants to merge 18 commits into from

Conversation

bennuttall
Copy link
Contributor

Initial commit of RPD image docs - more work to do, and will need some help with the content

and is intended to make these tools available to people without a Raspberry Pi.

Users can install the image on a CD/DVD or USB stick, and either use it as a
live disc (boot the OS without Installing it), install it on their computer or
Copy link
Contributor

Choose a reason for hiding this comment

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

Installing -> installing

# Raspberry Pi Desktop for PC and Mac

The Raspberry Pi Foundation provides a Debian-based operating system image
for x86 computers with the Raspberry Pi Desktop skin found in Raspbian.
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be worth mentioning that it boots on x64 computers too? (or is that too much of a subtle technical difference that most people won't understand?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks - I'll reword

@lurch
Copy link
Contributor

lurch commented Aug 14, 2017

I guess most of the "installing onto a USB stick" is already (indirectly) covered by https://github.com/raspberrypi/documentation/tree/master/installation/installing-images ?

@bennuttall
Copy link
Contributor Author

I've added some content - I'll be away for 2 weeks so if anyone is able to fill in the gaps, that would be handy.

@lurch
Copy link
Contributor

lurch commented Aug 20, 2017

There's a couple of places where "Insert the disk or USB stick in your computer before or after it starts booting." is used. As the 'disk' in this context is a DVD, I guess this should be 'disc'? Also, should the "before or after it starts booting" be changed to just "before it starts booting"? Not much point inserting the disc or USB stick after the computer has started booting?!

Also, there's a couple of places where the phrase "a CD/DVD" is used - the ISO image is far too big to fit on a CD, and will only fit on a DVD.

@JamesH65
Copy link
Contributor

JamesH65 commented Sep 7, 2017

@bennuttall Since you are back, have you got time to go through and finish this one off so it can be flagged for copy edit?

@bennuttall
Copy link
Contributor Author

I was looking to get some comments on what people think

@JamesH65
Copy link
Contributor

AFAICT, it only needs the installing on the USB stick section completed and that should be good enough to send to copy edit. We can always adjust/add later as necessary.

@JamesH65
Copy link
Contributor

This seems to have stalled - is anyone able to fill out the USB section?

@JamesH65
Copy link
Contributor

@bennuttall @lurch Should we just commit as is and fill in the missing sections at a later date?

@bennuttall
Copy link
Contributor Author

Sorry @JamesH65 I'm back (again) now. I'll try and tidy up to get ready to go live and we can add more detail later.

@bennuttall bennuttall self-assigned this Nov 23, 2017
@JamesH65
Copy link
Contributor

JamesH65 commented Mar 5, 2018

@bennuttall Hi Ben, what is left to do on this? I've got some spare time at home today so can full in any gaps - is it just the creating of the USB stick section as mentioned above?

First go at filling in the missing section. I've not tried this but I think its the right approach.
Removed reference to CD - the current image is too large to fit on a CD.
@JamesH65
Copy link
Contributor

JamesH65 commented Mar 6, 2018

@bennuttall @lurch I've added the USB/DVD section, and removed references to CD's - current image is too large for a CD. Anything else need to be added?

@bennuttall bennuttall changed the title Add x86 image documentation, close #710 WIP: add x86 image documentation, close #710 Mar 21, 2018
@JamesH65
Copy link
Contributor

Is this ready to go to copy edit? Be nice to get it merged. Ping @bennuttall @lurch

@bennuttall
Copy link
Contributor Author

Thanks @JamesH65 - I'm going to make a few small edits and it should be good to go. I've a feeling the screenshots might be out-of-date if they've not been updated since I first pushed them, but I can redo them easily enough.

@bennuttall
Copy link
Contributor Author

bennuttall commented Jul 10, 2018

Ok just needs new screenshots

@JamesH65
Copy link
Contributor

I'll flag as ready for CE then, that won't affect the pictures, and it'll probably be a while before the CE is done anyway.

@bennuttall
Copy link
Contributor Author

Pushed some more changes and added new screenshots.

@XECDesign would you be able to write a short bullet for each of the advanced boot options to clarify what they do here: https://github.com/raspberrypi/documentation/blob/710-x86-image-docs/installation/raspberry-pi-desktop/boot-options/README.md#options

Also I assume persistence is only available when on a USB stick (or VM) and not when on a DVD. Are the boot options different then, and/or should we point this out?

@XECDesign
Copy link
Contributor

Expert mode shows all the install options - may result in a standard debian install rather than one with RPD.
Rescue mode gives you access to tools to recover a failed install (if you need to reinstall the bootloader or access to a shell, for example).
Automated mode uses a user-provided preseed file which probably won't work, since we already provide one.

The advanced menu probably needs a warning rather than a description of the options.

- Install the OS fully using a command-line installer
1. **Graphical install**
- Install the OS fully using a graphical installer
1. **Advanced options**
Copy link
Contributor

Choose a reason for hiding this comment

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

Are there plans to replace the ????

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmmm, hadn't realised there were sections missing. @bennuttall Should we remove until have the required text, or fill in now?

@JaninaPi
Copy link
Contributor

JaninaPi commented Jul 20, 2018

Have checked all the files, will leave you to sort out the missing content. Let me know if there's anything else I should look at here.

@JamesH65
Copy link
Contributor

Thanks!

@bennuttall
Copy link
Contributor Author

TODO: add link from installing page!

@JamesH65
Copy link
Contributor

We should probably resurrect this...

@bennuttall
Copy link
Contributor Author

Yup. There's a guide here now too: https://projects.raspberrypi.org/en/projects/install-raspberry-pi-desktop

@bennuttall
Copy link
Contributor Author

Perhaps what we need here is documentation about it rather than a tutorial?

@aallan
Copy link
Contributor

aallan commented Jun 7, 2021

In light of #1911 is this PR still relevant? If there is supporting third-party documentation outside of this repo, and there hasn't been much recent progress I'd be inclined to close it?

@aallan aallan linked an issue Jun 7, 2021 that may be closed by this pull request
@bennuttall bennuttall closed this Jun 7, 2021
@aallan aallan deleted the 710-x86-image-docs branch June 25, 2021 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

x86 image documentation
6 participants