Skip to content

Commit 4626e73

Browse files
fixed pictures for MD version
1 parent 785a4cf commit 4626e73

File tree

6 files changed

+11
-4
lines changed

6 files changed

+11
-4
lines changed

others/best-practices/git/files/git.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,9 @@ A practical example to approach DevOps and CI/CD for Autonomous Database into OC
140140

141141
Find a high-level simplified view of actors(we will focus on Database Developers) and tasks we will explain in detail in this document:
142142

143-
![Database DevOps Flow](images/DevOpsDatabaseFlow-Flow.pdf)
143+
<!-- ![Database DevOps Flow](images/DevOpsDatabaseFlow-Flow.pdf) -->
144+
![Database DevOps Flow](images/DevOpsDatabaseFlow-Flow.png)
145+
144146

145147
## GIT with a Single Repository and Directory Structure
146148

96.4 KB
Loading
7.5 KB
Loading
44.2 KB
Loading
77.1 KB
Loading

others/best-practices/solution-documentation/files/solution-documentation.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,15 @@ To draw architecture diagrams, we use DrawIO. It is an easy-to-use tool to draw
5555

5656
We created two different styles for our notation. A logical style and a physical style, inspired by the original definitions by Zachman for [conceptual, logical, and physical system designs](https://zachman-feac.com/resources/ea-articles-reference/149-conceptual-logical-physical-it-is-simple). The logical notation represents a business point of view with user and data flows between capabilities or processes, instead of technology products. This view is more abstract and is very business-friendly. It can include technical generic capabilities such as 'integration', if required. The creator of a diagram needs to understand the audience and the purpose of the diagram, thus a logical notation can focus on business concepts only or somewhat bridge the gap to a technical view if needed.
5757

58-
![A logical example diagram created in DrawIO](images/logical.pdf)
58+
<!-- ![A logical example diagram created in DrawIO](images/logical.pdf) -->
59+
![A logical example diagram created in DrawIO](images/logical.png)
60+
5961

6062
On the other hand, the physical notation describes the final technical solution. It includes physical things, such as hard- or software components or networking details. It describes a system and what components are needed for a full implementation of the system.
6163

62-
![A physical example diagram created in DrawIO](images/physical.pdf)
64+
<!-- ![A physical example diagram created in DrawIO](images/physical.pdf) -->
65+
![A physical example diagram created in DrawIO](images/physical.png)
66+
6367

6468
The physical notation includes also a set of icons for different Oracle products, as seen in the image above.
6569

@@ -99,7 +103,8 @@ Using Markdown in an organization will incur two challenges. First, you need to
99103

100104
For the first challenge, we developed an internal tool, based on public open-source components, to translate a Markdown file into a branded PDF. The solution is based on [Pandoc](https://pandoc.org/) and [`\LaTeX`{=tex}](https://www.latex-project.org/) in the backend, while the user only writes Markdown. Languages such as HTML and `\LaTeX `{=tex}can also be used in the text if desired. On top of that, we developed some LUA scripts as a filter for Pandoc, which allows us to create and resolve variables that a user can define in a YAML metadata block. These variables can also be used to load pieces of text per condition like an If-Else statement. With that, we can easily define a variable for a customer name and switch a template from one customer to another. Or we can use a piece of text if a condition is true, such as 'high-availability = true'. Furthermore, we can convert multiple Markdown files into a single PDF output. This allows us to have a single main document, and maybe some chapters as an individual document shared between different team members if needed, or specific text block highly reusable shared between all users, such as disclaimers, safe harbor statements, product descriptions etc. Such snippets can then be centrally managed and updated, with the end users just retaining the reference to the snippets, not needing to update their documents.
101105

102-
![Markdown to PDF converter with corporate branding](images/converter.pdf)
106+
<!-- ![Markdown to PDF converter with corporate branding](images/converter.pdf) -->
107+
![Markdown to PDF converter with corporate branding](images/converter.png)
103108

104109
Here are some examples of such a document, with the use of variables and snippets:
105110

0 commit comments

Comments
 (0)