Cloudogu EcoSystem 문서(문서)

Cloudogu 생태계 문서 소개

좋은 소프트웨어의 원칙은 가능한 한 많이 복잡한 상호관계 사용자를 위해 이해할 수 있는 대표하다. 언뜻 보기에 Cloudogu EcoSystem은 표면 아래에 광범위한 작업을 숨기고 있지만 매우 단순해 보입니다. 이것이 바로 Cloudogu EcoSystem이 놀라운 수의 사용자 인터페이스를 제공하는 이유입니다. 우리는 다음과 같은 관습을 존중합니다. 사용자 친근성 그러나 우리가 알고 있는 한도 내에서 일부 기능은 설명이 필요한. 그래서 우리는 포괄적인 작업을 수행하기로 결정했습니다. 공개 문서 docs.cloudogu.com으로 지침을 작성합니다.

docs.cloudogu.com이 무엇인가요?

Docs.cloudogu.com은 Cloudogu EcoSystem에 대한 다양한 정보를 제공합니다.

• ㅏ 시작하기 새로운 사용자 또는 플랫폼에 관심이 있는 사용자를 위해.
• ㅏ 사용자 설명서 플랫폼 사용자를 위해.
• 하나 개발 문서 관리자 및 플랫폼 자체를 조정하려는 모든 사람을 위한 것입니다.

문서는 myCloudogu 서비스의 일부이며 docs.cloudogu.com에서 등록 없이 무료로 액세스할 수 있습니다.

docs.cloudogu.com은 나에게 무엇을 제공하나요?

설명서는 특히 다음을 목표로 합니다. 최종 사용자, 개발자 그리고 관리자 그리고 Cloudogu EcoSystem에 관심이 있는 누구나.

사용자 설명서

당사의 EcoSystem은 다양한 소프트웨어 애플리케이션을 강력한 도구 체인으로 결합하는 플랫폼입니다. 사용 설명서에서 당사의 사용자 인터페이스에 대한 자세한 정보를 찾을 수 있습니다. 자체 개발 도구 조종석 또는 워프 메뉴와 같은 사용 방법에 대한 지침을 받습니다. 사용 가능한 옵션과 성공적으로 상호 작용하는 방법을 배우게 됩니다.

개발자 문서

Cloudogu EcoSystem의 인스턴스를 관리하고 개발에 참여하고 싶습니다. 오픈 소스– 구성 요소에 참여하거나 기술적 맥락에 대한 더 깊은 통찰력을 얻으시겠습니까? 그런 다음 개발자 설명서에서 명령줄 옵션, 인터페이스 및 개발자가 내린 결정에 대한 질문에 답변합니다.

시작하기

Cloudogu EcoSystem은 민첩한 소프트웨어 개발을 위한 복잡한 제품입니다. 개별 구성 요소가 제공하는 것과 상호 작용하는 방식을 더 잘 이해하려면 설명서를 참조하여 자세한 질문을 하십시오. Cloudogu EcoSystem을 직접 사용해 보려면 시작하기 섹션에서 로컬 인스턴스를 설정하는 방법을 단계별로 보여줍니다.

설명서에서 아직 다루지 않은 질문이 있습니까? 그런 다음 커뮤니티 포럼에 게시해 주세요. 문서화된 오픈 소스 도구(예: Redmine, Jenkins 또는 Sonatype Nexus)의 사용자 인터페이스 및 옵션에 대한 자세한 내용은 제조업체 웹 사이트를 방문하십시오.

docs.cloudogu.com이 왜 있나요?

Cloudogu의 개발 원칙 중 하나는 문서를 가능한 한 코드에 가깝게 유지한다는 것입니다. 이는 사용자 인터페이스, 사용 및 관리에 대한 정보뿐만 아니라 코드 문서에도 적용됩니다. 또한 모순되는 정보를 방지하기 위해 가능한 한 적은 양의 콘텐츠를 두 번 유지하는 것을 매우 중요하게 생각합니다. 이것은 우리의 문서가 다양한 저장소 GitHub 및 SCM 관리자에서 분산 이다.

따라서 전체 구조에 대한 개요를 파악하는 것이 때때로 번거로웠습니다. 또한 문서는 소스 코드 저장소에 있습니다. 개발자가 아닌 사용자가 쉽게 액세스할 수 없음. 설명서의 탐색은 리포지토리에서도 최적이 아닙니다. 고객과 사용자를 위해 작업 방식의 단점을 보완하기 위해 모든 공개 문서를 한 곳에서 쉽게 액세스할 수 있도록 하기로 결정했습니다. 이러한 결정을 내리는 순간 다양한 사용자 요구 사항에 대한 포괄적인 문서를 구조화된 방식으로 제공할 수 있는 기회가 생겼습니다. 신뢰할 수 있는 단일 소스를 사용하면 공개 문서가 항상 최신 상태로 유지되므로 중복 콘텐츠를 수동으로 유지 관리할 필요가 없습니다.

후드 아래에 기술적으로 무엇이 있습니까?

Docs.cloudogu.com은 문서에서 선별된 콘텐츠를 제공하는 gatsby 사이트입니다. 개츠비는 웹사이트 생성기, React를 기반으로 합니다. 웹 프런트 엔드는 공통 라이브러리를 통해 스타일 및 공유 그래픽과 같은 myCloudogu 유니버스의 요소를 가져옵니다. 문서화 도구의 기술적 핵심은 다음을 기반으로 하는 스크립트입니다. git sparse checkout 리포지토리에서 설명서 구성 요소를 수집합니다. 방문할 각 저장소에는 JSON 파일 정의됩니다. 스크립트는 github.com과 내부 SCM 관리자를 모두 소스로 처리할 수 있습니다. 우리는 수집 마크다운 파일 그리고 이미지 파일.

그만큼 gatsby-transformer-remark 플러그인 수집된 Markdown 파일을 기반으로 HTML 콘텐츠를 생성합니다. Markdown 파일은 기계가 읽을 수 있는 “Markdown Abstract Syntax Trees”(mdAST 개체)로 변환되고 추가로 처리됩니다. gatsby-transformer-remark 플러그인은 다른 플러그인을 허용합니다. 자체 개발한 곳입니다. 트랜스포머 플러그인 저장된 규칙에 따라 문서를 준비하고 예를 들어 불필요한 바닥글을 제거합니다. 또한 플러그인은 소스 리포지토리에서 작동하는 상대 링크를 준비하여 문서에서도 작동하도록 합니다.

또한 널리 사용되는 API 쿼리 언어인 GraphQL을 사용하여 예를 들어 메뉴와 목차를 자동으로 생성합니다.

우리 개발자들에게 가장 흥미로운 과제는 이기종 환경에서 데이터를 성공적으로 수집하는 동시에 변화하는 요구 사항에 유연하게 대응할 수 있는 아키텍처를 만드는 것이었습니다(우리는 SCRUM 원칙에 따라 작업하고 새로운 결과에 대한 요구 사항을 지속적으로 조정합니다). 조직적인 관점에서 볼 때 공개 문서 작업을 통해 기존의 모든 문서를 통일된 표준에 따라 준비할 수 있었습니다.

무엇 향후 계획?

소프트웨어가 결코 “완성”되지 않는 것처럼 우리는 지속적으로 문서를 개발하고 있습니다. 글의 수와 깊이를 늘리고 Cloudogu EcoSystem과 관련된 모든 주제를 단계적으로 다룰 계획입니다. 우리는 또한 영어 버전에 대해 생각하고 있습니다. 사용성도 지속적으로 개선하겠습니다. 이 모든 문제에 대해 여러분의 도움이 필요합니다. docs.cloudogu.com을 사용하여 포럼에서 마음에 드는 점과 개선할 점을 알려주세요.