Comments (4)
Hi @Arjun-A3!
In case you're interested in migrating some of the pages from the old wiki to the new devdocs, here you have the instructions:
- Install the devdocs requirements (basically yarn): https://moodledev.io/general/documentation/contributing#installation
- Clone locally the Github devdocs repository (https://github.com/moodle/devdocs).
- Run
yarn install
andyarn start
commands (to start locally your devdocs project). - Look at the issues in the github project (https://github.com/moodle/devdocs/issues or https://tracker.moodle.org/browse/MDL-79219) and pick one of them. You can also run the script
./scripts/wikimedia-sync.js fetch-todo
to get the list of pages that still need to be migrated and then choose your favourite one. - Run
yarn migrate <wikimedia_page> <newpath>
to fetch the content and adapt it from the Wikimedia format to Markdown. For instance,yarn migrate Admin_tools general/projects/api/admin-tools.md
- Remember "docs" is for versioned pages depending on the Moodle version, like the APIs and "general" for unversioned pages, like the Coding style, the process or Tracker.
- Review the content, and improve it, to guarantee it's updated and has some of the nice Markdown features that Docusaurus includes (https://docusaurus.io/docs/markdown-features).
- Remember to add a link to the proper sidebar (docs.js or general.js).
- Once you're happy with the migrated page, commit changes, push them to your repository and create a pull request to the devdocs project.
Before starting any migration, this is the "cheating sheet" to commit and push your changes:
git checkout main
git pull
git checkout -b branchname
yarn migrate <wikimedia_page> <newpath>
git add -A
git commit -m '[docs] Migrate xxxx page'
git push origin branchname
Create a pull request to the devdocs project
There are also a few tools that can help you:
A. To find the list of pending pages that need to be migrated (or marked as WillNotMigrate) you can run the following command from the root of the devdocs folder:
node scripts/wikimedia-sync.js fetch-todo
B. To mark as WillNotMigrate obsolete pages or pages that make no sense to migrate to devdocs, you only need to edit the legacy page and add the following code at the beginning:
{{Template:WillNotMigrate}}
C. When you review the code, remember you can add some of the nice admonitions: https://docusaurus.io/docs/markdown-features/admonitions to make it more readable.
D. There are a couple of useful commands, to check the links and the spelling:
yarn mdlint-all
yarn spell
from devdocs.
Hi @Arjun-A3!
I would suggest ussing "`" , `styles_<theme name>.css`
If it doesn't work, you can also try to escape < using \ before it (so \<
)
from devdocs.
hey @sarjona,
I would like to work on the above-mentioned problem
can you provide a bit more information about the documentation?
from devdocs.
hey @sarjona,
I am working on migrating css_coding_style but unfortunately, I am Stuck at the migrating stage
can you help me out here
I tried changing or commenting out the 183rd line yet it did not work.
from devdocs.
Related Issues (20)
- [docs] Create documentation for [Moodle 4.2 release]
- [docs] Lack of information about $_GET, $_POST, $_REQUEST, $_COOKIE, and $_SESSION variables
- https://moodledev.io/general/development/tracker/labels should have an anchor for each lable
- https://docs.moodle.org/dev/Experience_API_(xAPI)
- Save useful info about question walkthrough tests from the comment in MDL-77327
- [docs] Update moodle version on QA testing page
- [docs] Update testing maintainer responsabilities
- [repo] Problem with documentation system HOT 1
- [docs] Important info missing from Javascript
- [docs] Error in repeat-elements
- [docs] Would be good to add an 'A better contribution' page explainging why it is best not to use setUp in PHPunit
- [docs] Migrate /dev/Cache_API to /docs/apis/subsystems/muc/index.md
- [repo] Moodle Sessions Bug Preventing First Admin Creation on Fresh Install HOT 1
- [docs] Create documentation for [Moodle 4.3 release] HOT 1
- Problems with the TinyMCE plugin docs HOT 2
- Notes: Notes.md HOT 1
- [docs] Error in [Writing a new service]
- Asignación de parches en el dispositivo HOT 1
- Valid and invalid example components don't meet WCAG AA level
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 devdocs.