Skip to content

Commit

Permalink
doc: initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
rmocanu-ionos committed Nov 25, 2024
1 parent d4235d5 commit 3c35f12
Show file tree
Hide file tree
Showing 9 changed files with 221 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
root: docs
structure:
readme: README.md
summary: summary.md
1 change: 1 addition & 0 deletions .github/IONOS.CLOUD.BLU.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: LiviusP

---

## Description
<!-- A clear and concise description of what the bug is. -->

## Expected behavior
<!-- A clear and concise description of what you expected to happen. -->

## Environment

GO version:
```
```
SDK version:
```
```
OS: <!-- use whatever fits and put it between the ```marks. -->
```
```

## Configuration Files
<!-- could also be environment settings, e.g. LANG=de_DE -->

## How to Reproduce
<!--
Steps to reproduce the behavior:
1. Go to '...'
2. Execute `acme --emca template.xml`
3. ...
Might be omitted if there are no choices, eg. the single command is already in the description
-->

## Error and Debug Output
<!--
Add anything, that could help here.
You can increase the debug level by .. ' hello --whatsover=example`
-->

## Additional Notes
<!--
Add any other content about the problem here.
-->

## References
<!--
Add any other related issues or other links that you think are important for fixing the bug.
-->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: IONOS Cloud API
url: https://devops.ionos.com/api/
about: View API documentation
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: LiviusP

---

### Current SDK Version
<!---
If you're not using the latest version, please check to see if something related to your request has already been implemented in a later version.
-->

```
...
```

### Use-cases
<!---
In order to properly evaluate a feature request, it is necessary to understand the use-cases for it.
Please describe below the end goal you are trying to achieve that has led you to request this feature.
Please keep this section focused on the problem and not on the suggested solution. We'll get to that in a moment, below!
-->

### Attempted Solutions
<!---
If you've already tried to solve the problem within SDKs existing features and found a limitation that prevented you from succeeding, please describe it below in as much detail as possible.
Ideally, this would include real code snippets that you tried and what results you got in each case.
Please remove any sensitive information such as passwords before sharing configuration snippets and command lines.
--->

### Proposal
<!---
If you have an idea for a way to address the problem, please describe it below.
In this section, it's helpful to include specific examples of how what you are suggesting might look in configuration files, or on the command line, since that allows us to understand the full picture of what you are proposing.
-->

### References
<!--
Are there any other GitHub issues, whether open or closed, that are related to the problem you've described above or to the suggested solution? If so, please create a list below that mentions each of them. For example:
- #6017
-->
21 changes: 21 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Build
on:
workflow_dispatch:
push:
branches:
- master
pull_request:
types: [opened, synchronize, reopened]
jobs:
sonarcloud:
name: SonarCloud
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
- name: SonarCloud Scan
uses: SonarSource/sonarcloud-github-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
68 changes: 68 additions & 0 deletions .github/workflows/issue-creation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: Issue Creation Tracker
on:
issues:
types: [ opened, reopened ]

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Git Issue Details
run: |
echo "Issue creator: ${{ github.event.issue.user.login }}"
echo "Issue title: ${{ github.event.issue.title }}"
echo "Issue number: ${{ github.event.issue.number }}"
echo "Issue url: ${{ github.event.issue.html_url }}"
- name: Google Chat Notification
run: |
curl --location --request POST '${{ secrets.ISSUE_TRACKER_WEBHOOK }}' \
--header 'Content-Type: application/json' \
--data-raw '{
"cards": [
{
"header": {
"title": "New Issue 🔨",
"subtitle": "Issue No: #${{ github.event.issue.number }}"
},
"sections": [
{
"widgets": [
{
"keyValue": {
"topLabel": "Repository",
"content": "${{ github.repository }}"
},
},
{
"keyValue": {
"topLabel": "Title",
"content": "${{ github.event.issue.title }}"
}
},
{
"keyValue": {
"topLabel": "Assigned Labels",
"content": "- ${{ join(github.event.issue.labels.*.name) }}"
}
},
{
"buttons": [
{
"textButton": {
"text": "OPEN ISSUE",
"onClick": {
"openLink": {
"url": "${{ github.event.issue.html_url }}"
}
}
}
}
]
}
]
}
]
}
]
}'
5 changes: 5 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# CHANGELOG

## 1.0.0
### Initial release
Object Storage Management API is a RESTful API that manages the object storage service configuration for IONOS Cloud.
12 changes: 12 additions & 0 deletions sonar-project.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
sonar.projectKey=ionos-cloud_sdk-go-object-storage-management
sonar.organization=ionos-cloud

# This is the name and version displayed in the SonarCloud UI.
#sonar.projectName=sdk-go-object-storage-management
#sonar.projectVersion=1.0

# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
#sonar.sources=.

# Encoding of the source code. Default is default system encoding
#sonar.sourceEncoding=UTF-8

0 comments on commit 3c35f12

Please sign in to comment.