Skip to content

Home

Jump to bottom
Xinyu Zhang edited this page Nov 18, 2021 · 16 revisions

JIPCAD Website Editing Tutorial

The intention of starting the JIPCAD website is for hosting and maintaining the JIPCAD documentation. Besides, to allow for a place where the amazing creations of URAP members can be exhibited. Therefore, every JIPCAD contributor is encouraged to update and improve the JIPCAD documentation and create blogs to show your creations and illustrate how you have created them. It's also more than welcome if you could contribute to the general Q&A page to report and document any bug or bummer you have encountered while using the software so that the other members could benefit tremendously from your post. Then let's dive into the structure of the website and see where should you put your editions.

1. Website Structure

The current JIPCAD documentation includes the following parts

  • Documentation
    • Introduction
      • The general introduction which explains what is JIPCAD and why it's initiated.
    • Compiling
      • The compiling guide shows you the compiling procedure of the software from the source code.
    • Tutorial
      • User Guide
        • The user guide doesn't touch the code part.
        • This session includes how to use JIPCAD software.
        • Examples that tell you how to advance the JIPCAD tool.
      • Developer Guide
        • The developer guide is for those who intend to contribute to the JIPCAD code base.
        • The general mechanism of how the code works.
        • Gives you an idea of what different parts of the code do.
        • The data structures and dependencies used in the codebase.
        • Once your interest is set, which part of the code should you read and touch.
    • JIPCAD language reference
      • Configuration
        • The configurations of the JIPCAD file.
      • Numerical Parameters and Sliders
        • Use of sliders
        • Time-varying models​
      • Generators
        • How to generate all available geometric shapes
      • Rendering Specifications
      • Numerical Parameters and Sliders
      • Generators
      • Rendering Specifications
    • Error Reporting
      • As the JIPCAD software is in development, the error reporting reveals the current imperfections you should be aware of.
      • Host crashes and bugs each URAP member encounters:
        • If you have made things work, how?
        • If things unfortunately failed, which file and what operations have led to the happening?
  • Exhibition
    • The exhibition page is set up for showing all works completed by JIPCAD artists.
    • The inclusion of detailed steps which have led you to the creation of the masterpiece is appreciated.
  • Download
    • The download page keeps the Mac and Windows executables.
    • Version management should be maintained on this page to keep logging the updates and new features of JIPCAD software.

Website Management

1.1 Website Files

Edit the files in the corresponding folder to manage the website contents after switching to the source branch.

1.2 Website Editing

1.2.1 Get The Source Code

In the website repo, there are two branches:

  • main branch
    • Where the deployed built is hosted and what people see at the website.
    • Do Not Directly Edit Files At the Main Branch!!!
  • source branch
    • Where the source code before the building is hosted. Use the git to get the code and switch to the source branch. Edit and push files at the source branch and then deploy the code following the 1.3 chapter.

1.2.2 More Instruction

The website uses docusaurus as the backbone, you could read the docusaurus doc for more instruction.

1.3 Website Deployment

Deploy to the GitHub io page, use the following bash command.

NODE_OPTIONS=--openssl-legacy-provider DEPLOYMENT_BRANCH=main GIT_USER="User" yarn deploy
Clone this wiki locally