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! Volto Light Theme Training docs. #861

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

iRohitSingh
Copy link

@iRohitSingh iRohitSingh commented Nov 3, 2024


📚 Documentation preview 📚: https://plone6--861.org.readthedocs.build/

@iRohitSingh iRohitSingh changed the title Volto Light Theme Training docs. WIP! Volto Light Theme Training docs. Nov 3, 2024
@iRohitSingh
Copy link
Author

@danalvrz @fredvd feel free to add your ideas. Currently I am just underlying my ideas.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Overall, I have no idea what you want to present, other than you use the term VLT. I guess your training has something to do with VLT. What do you intend to actually do?

I think it may be more helpful for you to outline what you plan to present during your training before you write it.

I'd be happy to discuss your ideas with you, or provide any other help I can. Please let me know. Thank you!

docs/volto-light-theme/adding-installing-new-block.md Outdated Show resolved Hide resolved
docs/volto-light-theme/creating-new-project.md Outdated Show resolved Hide resolved
docs/volto-light-theme/creating-new-project.md Outdated Show resolved Hide resolved
docs/volto-light-theme/index.md Show resolved Hide resolved
docs/volto-light-theme/installing-vlt.md Outdated Show resolved Hide resolved
docs/volto-light-theme/installing-vlt.md Outdated Show resolved Hide resolved
docs/volto-light-theme/installing-vlt.md Outdated Show resolved Hide resolved
docs/volto-light-theme/installing-vlt.md Outdated Show resolved Hide resolved
docs/volto-light-theme/installing-vlt.md Outdated Show resolved Hide resolved
@nileshgulia1
Copy link
Member

@iFlameing You should assist @iRohitSingh with writing this training.

@iRohitSingh
Copy link
Author

@nileshgulia1 @stevepiercy I am just outlining the training and putting all my raw thoughts together. I will ask for your review once I have something to show. This is only for my documentation and for sharing with Dante. I will ping you once I am ready to show and discuss it with all of you. Please don't review it this time. I will reach out when it's ready. I’ve marked it as WIP in the heading.

sorry for miscommunication.

@iRohitSingh
Copy link
Author

@stevepiercy I am resolving all your comment. Once I have a proper structure, I will ping you for your review.

@iRohitSingh iRohitSingh marked this pull request as draft November 12, 2024 19:38
docs/volto-light-theme/adding-installing-new-block.md Outdated Show resolved Hide resolved
docs/volto-light-theme/adding-installing-new-block.md Outdated Show resolved Hide resolved

After that you have to run it to create the project.
First, install `cookieplone`, a tool for setting up new Plone projects, using `pipx`:
Copy link
Contributor

Choose a reason for hiding this comment

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

Does the participant already have pipx installed from somewhere else in this tutorial?

Did they create a virtual environment?

Did they activate it (not a good practice) or use venv/bin/pipx?

Ack! I just realized we have an issue with the [new docs method to install pipx. @davisagli let's chat about the official recommendation to install pipx. I think our current method of pip install pipx will trip up some users who might try to install it into their system Python with sudo or who might create a virtual environment and activate it 😱. I much prefer to link to official docs.

Copy link
Contributor

Choose a reason for hiding this comment

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

See plone/documentation#1771 for follow up.

docs/volto-light-theme/creating-new-project.md Outdated Show resolved Hide resolved
docs/volto-light-theme/creating-new-project.md Outdated Show resolved Hide resolved
docs/volto-light-theme/creating-new-project.md Outdated Show resolved Hide resolved
docs/volto-light-theme/creating-new-project.md Outdated Show resolved Hide resolved
docs/volto-light-theme/creating-new-project.md Outdated Show resolved Hide resolved
docs/volto-light-theme/installing-vlt.md Outdated Show resolved Hide resolved
docs/volto-light-theme/theming.md Outdated Show resolved Hide resolved
@iRohitSingh
Copy link
Author

@stevepiercy I will ping you once I have a proper draft for review. I will fix all the grammar and things once I have enough content for training. Currenlty I am writing what is coming to mind. This is my first time writing technical docs so I am making some silly mistakes. Once I am complete with content, I will polish it and ask your preview. Please don't invest your time on this for now.

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