Comments (10)
@CodeWithEmad ah sorry that's not me 😅
I think some of it you could get started on like adding notes about the cookiecutter. This seems like a big ticket that would probably benefit from multiple PRs to make smaller changes to get feedback on. You could also try posting specific questions in the forum (maybe one at a time, to generate a more focused discussion)
from xblock.
Yes @sarina, I'm reading xblock docs from docs.openedx.org
I mean here:
from xblock.
@CodeWithEmad thanks for catching that, I've fixed it.
from xblock.
Also, the URL in the repository about section return 404
https://edx.readthedocs.io/projects/xblock-tutorial/en/latest/overview/introduction.html -> should be https://docs.openedx.org/projects/xblock/en/latest/index.html
from xblock.
Hi @CodeWithEmad - is this a ticket you're planning to tackle, and would like some advice? Or are you making a general ticket for someone else to work on?
from xblock.
Hey @sarina. I am interested in contributing to this project, but I am not fully current with the recent Xblocks changes. It would be very beneficial to have a brief discussion with someone who is more closely involved with Xblock-related matters.
from xblock.
@CodeWithEmad You are right, the XBlock docs could really use some work, and your suggestions are good ones. +1 to Sarina's suggestion with breaking of proposal into smaller PRs, and the cookiecutter note is definitely a safe place to start.
I'm happy to discuss the recent and upcoming XBlock changes so that you have all the information you need. Is there anything in particular you are wondering?
from xblock.
Thanks for your suggestions. I'll create smaller PRs to update the docs but it might take a while. I'm also open to any suggestions.
Well, I'm not the master of writing XBlocks, but for starters, one thing that I didn't find anywhere was the runtime services list and how the "needs" and "wants" decorators work and what the differences are. also, what about the React in xblocks?
I find the proposal about the XBlock v2 and the XBlock rending summit, but I've no information about them.
from xblock.
as the first attempt to improve the XBlock repo, I made this to clean up the readme and some smaller fixes:
Also, the link inside the repos URL returns 404: https://edx.readthedocs.io/projects/xblock-tutorial/en/latest/overview/introduction.html
from xblock.
It's here: https://docs.openedx.org/projects/xblock/en/latest/xblock-tutorial/index.html
from xblock.
Related Issues (20)
- Prototype: React-enabled XBlocks
- React Support for XBlock frontends HOT 2
- Merge `openedx/xblock-utils` library into `openedx/XBlock` HOT 10
- Switch off of deprecated `pkg_resources` library HOT 1
- Switch off of deprecated `pkg_resources` library HOT 4
- Add type hints and check them in CI HOT 7
- Assume that scope IDs are opaque key objects HOT 3
- Better type checking for XBlock fields HOT 1
- [DEPR]: Extraneous XBlock Mixins HOT 3
- Test openedx/XBlock with Python 3.11 and 3.12 HOT 1
- Refactor or deprecate parent-child relationships between XBlocks HOT 1
- Test XBlock on Python 3.11
- [docs] deploying docs should mention creating a release manually is required
- Update edx-cookie-cutter
- Drop support for Python 3.8
- Xblock version 5.0.0 broke plugin HOT 4
- Test XBlock on Ubuntu 24.04
- [DEPR]: Support for XBlock Runtimes with raw string scope IDs HOT 4
- Update certain unit tests to use OpaqueKeys instead of strings for scope IDs. HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from xblock.