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

Update Budgie-related docs and screenshots #131

Open
5 tasks
JoshStrobl opened this issue Apr 19, 2018 · 3 comments
Open
5 tasks

Update Budgie-related docs and screenshots #131

JoshStrobl opened this issue Apr 19, 2018 · 3 comments

Comments

@JoshStrobl
Copy link
Member

JoshStrobl commented Apr 19, 2018

There is a multitude of documents that use outdated references, screenshots, instructions, etc. for Budgie (such as showing Budgie Settings in Raven as opposed to the dedicated app).

If anyone is interested in updating the documentation before I can get around to it, consider this the discussion issue and reference point for items which need to be changed, how screenshots should be taken, settings used, etc.

🥇 Items that need updating:

  • Changing Background configuration/changing-background/en.md
  • Configuring Date and Time configuration/configuring-date-and-time/en.md
  • Configuring Sound and Sound Devices configuration/configuring-sound-and-sound-devices/en.md
  • Enabling Desktop Icons configuration/enabling-desktop-icons/en.md
  • Enabling Workspaces configuration/enabling-workspaces/en.md

Note: The above referenced documents are the Markdown files and not the associated image files. The screenshots are in the respective folders in imgs/. You may find in some documentation that only updating the screenshot is necessary, and that's perfectly okay.

✔️ Screenshot specification:

  • You should be using the default theming, namely:
    • Adapta for GTK theme
    • Papirus for Icon theme
    • Breeze for Cursor Theme
    • Sections which show off specific parts of the panel should be using the default as well. If you're unsure and you're willing to drop your pinned apps, follow this doc.
  • Language should be set to English (US).
  • Minimal cropping of the image should occur and your files should be saved as JPG. If you're using GNOME Screenshot, open up GIMP and convert. Keep 100% quality, I can compress it post-merge, and refrain from over-cropping (I can always crop it further post-merge).
    • However: Refrain from taking full screen screenshots and maximizing applications.

⭐ Bonus points (not necessary):

  • Add more relevant Budgie documentation based on functionality exposed in the Budgie Settings app, such as basics to Budgie and applet configuration. Budgie documentation should go in budgie/ and create screenshot folders as necessary (see other existing folders for examples).
@guillotjulien
Copy link

Hi !

Do you still need help with this task ? And does it also involve writing some text ?

@Girtablulu
Copy link
Contributor

I made PR for all of them and would continues after them creating some other guides for budgie desktop, but I have a question regarding the folder layout and design how you would like it.

should I create under /help-center-docs/budgie and configuration subfolder and add there the different guides regarding configuration or should I throw them directly under Budgie?

Guide Ideas:
Icon changes + adding new icons
theme changes + adding new icons
general panel + applet guide
applet install guide + SC install and manual install
autostart guide

any other ideas?

@oaksisfolks
Copy link

Have you gotten screenshots? I can provide anything needed in that regard, including screenshots and video in open codecs/containers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog
Development

No branches or pull requests

4 participants