Skip to content

Commit 012d609

Browse files
author
Shelson Ferrari
committed
geracao de directory.md com menu wiki e ajustes dos menus
1 parent f0bf823 commit 012d609

7 files changed

Lines changed: 71 additions & 6 deletions

File tree

ARCHITECTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ The architecture of this project is designed to be modular and scalable, using D
212212
213213
### 3. Project Structure
214214
- [Folder Structure](/DIRECTORY.md): Description of the organization of the project directories.
215-
- [Project Architecture](/ARCHITECTURE.md): Explanation of the architecture used, including design patterns and technical decisions.
215+
- **Project Architecture**.
216216
217217
### 4. Development
218218
- [Development Flow](https://github.com/33mestre/java_base/wiki/development-flow): Description of the development process adopted, including planning, coding, and review stages.

AUTHORS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This project is maintained by:
2828

2929
### 4. Development
3030
- [Development Flow](https://github.com/33mestre/java_base/wiki/development-flow): Description of the development process adopted, including planning, coding, and review stages.
31-
- [Contributors and Authors](/AUTHORS.md): Recognition of the contributors to the project.
31+
- **Contributors and Authors**.
3232
- [Contributions](/CONTRIBUTING.md): Guidelines on how to contribute to the project, including code standards and pull request requirements, tips and best practices.
3333
- [Code of Conduct](/CODE_OF_CONDUCT.md): Behavioral guidelines expected for the project community.
3434

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
6868
- [Development Flow](https://github.com/33mestre/java_base/wiki/development-flow): Description of the development process adopted, including planning, coding, and review stages.
6969
- [Contributors and Authors](/AUTHORS.md): Recognition of the contributors to the project.
7070
- [Contributions](/CONTRIBUTING.md): Guidelines on how to contribute to the project, including code standards and pull request requirements, tips and best practices.
71-
- [Code of Conduct](/CODE_OF_CONDUCT.md): Behavioral guidelines expected for the project community.
71+
- **Code of Conduct**.
7272

7373
### 5. API and Documentation
7474
- [OpenAPI Specification](https://github.com/33mestre/java_base/wiki/openapi-specification): Details about the OpenAPI specification used to document the API endpoints.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ If you have any questions, contact [shelson@gmail.com](mailto:shelson@gmail.com)
6666
### 4. Development
6767
- [Development Flow](https://github.com/33mestre/java_base/wiki/development-flow): Description of the development process adopted, including planning, coding, and review stages.
6868
- [Contributors and Authors](/AUTHORS.md): Recognition of the contributors to the project.
69-
- [Contributions](/CONTRIBUTING.md): Guidelines on how to contribute to the project, including code standards and pull request requirements, tips and best practices.
69+
- **Contributions**.
7070
- [Code of Conduct](/CODE_OF_CONDUCT.md): Behavioral guidelines expected for the project community.
7171

7272
### 5. API and Documentation

FUTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The items mentioned here do not have a set timeline for if and when they will be
6868
- [Terms of Use](https://github.com/33mestre/java_base/wiki/terms-of-use): Information about the terms and conditions for using the software.
6969

7070
### 12. Projections and Innovations
71-
- [Future Plans](/FUTURE.md): Discussion on functionalities and improvements considered for future versions of the project.
71+
- **Future Plans**.
7272
- [Improvement Proposals](https://github.com/33mestre/java_base/wiki/improvement-proposals): Space for the community to suggest and debate improvements and innovations.
7373

7474
### 13. Attachments and Useful Links

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,4 +100,4 @@ Thank you for helping us keep our project secure.
100100
- [External Links and References](https://github.com/33mestre/java_base/wiki/external-links-and-references): Additional resources and external documentation relevant to the project.
101101

102102
### 14. Security
103-
- [Security Policy](/SECURITY.md): Details on the supported versions, reporting vulnerabilities, and general security practices.
103+
- **Security Policy**.

sys/directory.groovy

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,71 @@ def generateDirectoryMarkdown(rootDirPath, baseUrl, outputFilePath) {
9595
writer.append("${packageDoc}\n\n")
9696
}
9797

98+
writer.append("\n")
99+
.append("## Wiki Menu\n")
100+
.append("\n")
101+
.append("[Home Page](/README.md)\n")
102+
.append("\n")
103+
.append("### 1. Introduction to the Project\n")
104+
.append("- [Overview](https://github.com/33mestre/java_base/wiki/overview): Presentation of the project, highlighting its purpose and the context in which it is embedded.\n")
105+
.append("- [Project Objectives](https://github.com/33mestre/java_base/wiki/project-objectives): Enumeration of the main objectives that the project aims to achieve.\n")
106+
.append("- [Scope and Functionalities](https://github.com/33mestre/java_base/wiki/scope-and-functionalities): Description of the main functionalities offered by the project and its scope of operation.\n")
107+
.append("\n")
108+
.append("### 2. Configuration and Installation\n")
109+
.append("- [Initial Configurations](https://github.com/33mestre/java_base/wiki/initial-configurations): Steps required to set up the development or production environment.\n")
110+
.append("- [Installation Instructions](https://github.com/33mestre/java_base/wiki/installation-instructions): Detailed procedures for installing the project in different environments.\n")
111+
.append("- [Docker Configuration](https://github.com/33mestre/java_base/wiki/docker-configuration): Specifications on how to configure and use Docker for the project.\n")
112+
.append("\n")
113+
.append("### 3. Project Structure\n")
114+
.append("- **Folder Structure**\n")
115+
.append("- [Project Architecture](/ARCHITECTURE.md): Explanation of the architecture used, including design patterns and technical decisions.\n")
116+
.append("\n")
117+
.append("### 4. Development\n")
118+
.append("- [Development Flow](https://github.com/33mestre/java_base/wiki/development-flow): Description of the development process adopted, including planning, coding, and review stages.\n")
119+
.append("- [Contributors and Authors](/AUTHORS.md): Recognition of the contributors to the project.\n")
120+
.append("- [Contributions](/CONTRIBUTING.md): Guidelines on how to contribute to the project, including code standards and pull request requirements, tips and best practices.\n")
121+
.append("- [Code of Conduct](/CODE_OF_CONDUCT.md): Behavioral guidelines expected for the project community.\n")
122+
.append("\n")
123+
.append("### 5. API and Documentation\n")
124+
.append("- [OpenAPI Specification](https://github.com/33mestre/java_base/wiki/openapi-specification): Details about the OpenAPI specification used to document the API endpoints.\n")
125+
.append("- [API Documentation with Swagger](https://github.com/33mestre/java_base/wiki/api-documentation-with-swagger): Information on how to access and use the interactive API documentation generated by Swagger.\n")
126+
.append("- [Javadoc Documentation](https://github.com/33mestre/java_base/wiki/javadoc-documentation): Information on the Javadoc documentation generated for the project.\n")
127+
.append("\n")
128+
.append("### 6. Endpoints and Database\n")
129+
.append("- [Endpoint Description](https://github.com/33mestre/java_base/wiki/endpoint-description): Details of the available API endpoints, including methods, parameters, and usage examples.\n")
130+
.append("- [Database Management](https://github.com/33mestre/java_base/wiki/database-management): Strategies and practices for efficient management of the database used by the project.\n")
131+
.append("\n")
132+
.append("### 7. Testing\n")
133+
.append("- [Testing Strategies](https://github.com/33mestre/java_base/wiki/testing-strategies): Approach and methods used to test the software, including unit, integration, and E2E tests.\n")
134+
.append("- [Testing Tools](https://github.com/33mestre/java_base/wiki/testing-tools): Description of the testing tools used in the project and how to configure them.\n")
135+
.append("\n")
136+
.append("### 8. CI/CD and Automations\n")
137+
.append("- [CI/CD Pipeline](https://github.com/33mestre/java_base/wiki/ci-cd-pipeline): Explanation of the continuous integration and delivery pipeline, detailing each stage and its function.\n")
138+
.append("- [Automations and Artifact Generation](https://github.com/33mestre/java_base/wiki/automations-and-artifact-generation): Description of the automations incorporated into the CI/CD, including documentation generation and build artifacts.\n")
139+
.append("\n")
140+
.append("### 9. Configuration Files\n")
141+
.append("- [.gitignore, .editorconfig and project.properties](https://github.com/33mestre/java_base/wiki/gitignore-and-editorconfig-and-project-properties): Utility of these files to maintain code consistency and quality.\n")
142+
.append("- [Maven Wrapper and application.properties](https://github.com/33mestre/java_base/wiki/maven-wrapper-and-application-properties): Explanation of how these files help standardize the development environment.\n")
143+
.append("- [.env File and Travis CI Settings](https://github.com/33mestre/java_base/wiki/env-file-and-travis-ci-settings): Use of these files to configure the environment and CI integrations.\n")
144+
.append("\n")
145+
.append("### 10. Best Practices\n")
146+
.append("- [Code Standards and Security](https://github.com/33mestre/java_base/wiki/code-standards-and-security): Guidelines for maintaining code quality and security.\n")
147+
.append("- [Monitoring and Logging Practices](https://github.com/33mestre/java_base/wiki/monitoring-and-logging-practices): Recommended techniques for monitoring and logging in the project.\n")
148+
.append("\n")
149+
.append("### 11. Legal and Licensing\n")
150+
.append("- [Licensing](https://github.com/33mestre/java_base/wiki/licensing): Information about the rights and restrictions associated with the use of the software.\n")
151+
.append("- [Terms of Use](https://github.com/33mestre/java_base/wiki/terms-of-use): Information about the terms and conditions for using the software.\n")
152+
.append("\n")
153+
.append("### 12. Projections and Innovations\n")
154+
.append("- **Future Plans**.\n")
155+
.append("- [Improvement Proposals](https://github.com/33mestre/java_base/wiki/improvement-proposals): Space for the community to suggest and debate improvements and innovations.\n")
156+
.append("\n")
157+
.append("### 13. Attachments and Useful Links\n")
158+
.append("- [External Links and References](https://github.com/33mestre/java_base/wiki/external-links-and-references): Additional resources and external documentation relevant to the project.\n")
159+
.append("\n")
160+
.append("### 14. Security\n")
161+
.append("- [Security Policy](/SECURITY.md): Details on the supported versions, reporting vulnerabilities, and general security practices.\n")
162+
98163
def filePath = Paths.get(outputFilePath)
99164
Files.write(filePath, writer.toString().bytes, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING)
100165
println("File 'DIRECTORY.md' generated successfully.")

0 commit comments

Comments
 (0)