Giter Club home page Giter Club logo

docs's Introduction

ZenUml

ZenUml is an online tool generating UML Sequence Diagram from a C-like DSL. This repository is used to track defects, suggestions and feature request.

Here is an example:

sequence diagram example

docs's People

Contributors

dyon21 avatar iamshaynez avatar mrcoder avatar unimu-cic avatar yanhuilioracle avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

docs's Issues

Add robot file to block Google Crawler from indexing Web App and Confluence App pages

I have added to to docs repo, but it is cross Web App and Confluence App.

It can be a work or some page rule that returns a robot file for to following domains:

  1. conf-full.zenuml.com
  2. conf-lite.zenuml.com

This will ensure that Google won't index those pages.

Related error: https://search.google.com/search-console/index/drilldown?resource_id=sc-domain%3Azenuml.com&item_key=CAMYDyAC&hl=en&sharing_key=6cviEaKh3UboBbX2OltGzQ

Disable Homepage Cache

昨天我们注意到Ruixing的机器上缓存了首页,以至于他获得首页上的CSS并不存在。清空Cloudflare缓存之后,问题消失。

这张卡用于跟踪该问题的解决:

  1. 确认Cloudflare是否缓存了首页HTML资源;
  2. 理解为何其他人的机器上都没有出现该问题,或者重现该问题;
  3. 修改CF的缓存规则(该修改应当计入release日志)

Homepage Response Headers

CF的Response里面有两个有关Cache的Header:

Cache-Control: public, max-age=0, must-revalidate
Cf-Cache-Status: BYPASS

从这两个Header看,CF的缓存规则并没有缓存首页。

  • Cache-Control: public, max-age=0, must-revalidate: This header suggests that while the resource is public and can be cached, it should not be stored for any duration (max-age=0) and must be revalidated with the origin server before being served.
  • Cf-Cache-Status: BYPASS: This indicates that Cloudflare did not serve this resource from its cache and bypassed the cache for this request.
Full Response Header List
Access-Control-Allow-Origin: *
Cache-Control: public, max-age=0, must-revalidate
Cf-Apo-Via: origin,cookie
Cf-Cache-Status: BYPASS
Cf-Ray: 82bd07bd9efdaad1-SYD
Content-Encoding: br
Content-Type: text/html; charset=utf-8
Date: Sat, 25 Nov 2023 21:36:58 GMT
Nel: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Referrer-Policy: strict-origin-when-cross-origin
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=CEZPkqO54uSlv3HFBs8aJ5%2BzWWOiIYanzy%2B7AwHDbYfm0vw15G6kpL%2FhWbMyZlSCAOw2MeB81bjbY4IwDr6PGYG8yegB27tDvlvwjuERG5wd58EMaGqmBR6jI%2F7F"}],"group":"cf-nel","max_age":604800}
Server: cloudflare
Strict-Transport-Security: max-age=15552000; includeSubDomains
Vary: Accept-Encoding
X-Content-Type-Options: nosniff

Add more icons

Linked issue (mermaid-js/zenuml-core#77) for @zenuml/core.

Add the following icons:

Group 1

  1. Client
  2. Server
  3. Browser
  4. Service
  5. Controller
  6. API (Application Programming Interface)
  7. UI (User Interface)
  8. Mobile
  9. ExternalSystem

Group 2

  1. Application
  2. LoadBalancer
  3. Network
  4. Cache
  5. WebServer
  6. MessageQueue
  7. Scheduler
  8. Gateway
  9. AuthenticationService
  10. MailServer

Group 3

  1. GitHub
  2. Docker
  3. GitLab
  4. Jenkins
  5. PostgreSQL
  6. MongoDB
  7. Kubernetes
  8. Apache Kafka
  9. Elasticsearch
  10. Auth0
  11. Redis

Black Friday discount for the Mac application

黑五是11月24号。我们先内部预热起来。

  • 11月10号首页预热
  • 11月11号给Web注册用户发邮件
  • 11月24号降价到冰点0.99 (1.99?)
  • 11月25号恢复原价,撤下首页宣传

圣诞特价

  • 12月10号首页预热圣诞和Boxing day半价
  • 12月11号给Web注册用户发邮件
  • 12月24号降价到半价12.99
  • 1月10号恢复原价,撤下首页宣传

Redesign of Home Page

Lifecycle解释
首页的主要面向人群从搜索来的C端用户。我们不把B端用户作为主要对象,因为二者并不容易兼容。我们主要使用marketplace的Listing页面服务B端用户。

Upgrading instructions and benefits

Add a page to zenuml.com at zenuml.com/upgrade. On this page add the following content:

Please use Chat GPT to refine the content.

Upgrading instructions

  1. Go to marketplace
  2. Click Try for free

Benefits

  1. No upgrading instructions on the exported PDF
  2. Priority support

FAQ

  1. Will my current macros be migrated automatically?

Answer version 1 (first release):
No. You can submit a ticket at https://zenuml.atlassian.net/servicedesk/customer/portals. We are happy to help you migrate all your macros.

Answer version 2 (next release after we have added the migrate button):
No. But you can open dashboard and click the migrate button. This button will migrate all the macros in the current space to the paid version.

  1. Do I have to subscribe?

Yes. No upgrading instructions will be displayed during the trail period. But after that a subscribing instructions will be displayed at the same place.

ZenUML.com clone

把ZenUML.com的内容用Docusaurus重新实现,包含大部分内容即可。

Fetch and render OG images for links on pages

It is an idea that we develop a plugin for DocuSaurus that automatically fetches and renders Open Graph (OG) images from external links included in markdown files.

Use case

Content is critical for our SEO and overall marketing success. A convenient way to include existing sequence diagram on pages/articles is useful.

We have said we will support one way to include diagram which is using code block like below:

```
A.method
```

With this one, it is easy to compose.

This proposal is for a different use case - to include an existing diagram from our diagram gallery. The extra benefit is that it can link back to the original diagram on our site which is useful to build an SEO network.

Proposed Functionality

  1. Link Scanning: Automatically scan markdown files for links from our gallery during the build process.
  2. OG Image Fetching: For each link, make an HTTP request to fetch the HTML content and parse it to extract the OG image URL (from og:image meta tags).
  3. Image Storage: Download these images and include them in the build artifacts.
  4. Image Rendering: Modify the page rendering logic to display these images alongside their respective links.
  5. Performance Optimization: Implement caching mechanisms to prevent repeated downloads of the same image and consider image optimization for faster loading.
  6. Error Handling: Robust error handling for scenarios where an OG image is not available or cannot be fetched.

OG image for home page

Current OG image for our home page is the default Docusaurus.
Screenshot 2023-11-09 at 7 31 35 pm

If we don't have a better option, the first image is a candidate:

image
Or
image

Monitor traffic on https://zenuml.com/upgrade

Dependency: #41

这张卡的目标是监控有多少用户会访问这个页面获取有关升级到Full的信息。

假设

用户导出PDF之后发现上面有提示升级的信息,他们中的一部分会去查看该页面,并通知Admin。

Deploy Home page (and doc site) to Cloudflare Pages

我们的决定是首页和文档站放在一起。旧的首页没有太多的依赖,所以切换起来比较简单,主要是DNS的操作。

Check List:

  • GitHub actions to deploy
  • Prod and Staging Env

Doc Site Content Structure

Get Started

Syntax with examples

This section provides practical tutorial on ZenUML DSL with inline playground.

FAQs

General

  1. Is there a license applied on the generated content
  2. Is ZenUML Open source
  3. What is the roadmap of the products

Elements on the diagram

Message

  1. Fundamentals and Standards
  2. What is the difference between Sync messages and Async messages
  3. How to change the style of a message
  4. How to draw a reply message (3 ways)

Participant

  1. Fundamentals and Standards
  2. How to change the colour of a participant
  3. How to assign icons to a participant
  4. How to change the order of participants

Fragments (Alt, Opt, Loop, etc.)

  1. Fundamentals and Standards
  2. What is the difference between Alt and Opt

Tools

  1. What is the difference between ZenUML and Sequence Diagrams using PlantUML, SequenceDiagram.org, WebSequenceDiagrams.com and Mermaid
  2. How to share my diagram
  3. How to export my data

Products

  1. Web App
  2. Confluence Plugin
  3. JetBrains Plugin
  4. Desktop
  5. Chrome Extension

Examples

  1. Online Shopping
  2. Library
  3. Registration and Login
  4. Car Rental
  5. Loop, Alt

官网 Pricing 页面 - 设计

  • 当前提供 Basic 和 Professional 版本,Premium 可以设计问号?或用其他方式表达「尽请期待」的含义。

可能的命名:

免费版:
中文名称:基础版
英文名称:Basic

中级付费版:
中文名称:专业版
英文名称:Professional

高级付费版:
中文名称:旗舰版
英文名称:Premium

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.