[docs/folder-structure] Changed Docs Structure / MDM Fixes #1094

hosy · 2022-01-21T13:50:41Z

Description

added missing link in MDM description
moved ios_mdm_tables.adoc output into new folder structure
removed no longer needed docs folder

Related Issue

#1070 #1075 #1082

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
Added an issue with details about all relevant changes in the iOS documentation repository.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.
Added changelog files for the fixed issues in folder changelog/unreleased

- added missing link in MDM description - moved ios_mdm_tables.adoc output into new folder structure - removed no longer needed docs folder

mmattel · 2022-01-21T14:23:04Z

Great, many thanks!

Note that I have copied the ios_mdm_tables.adoc file from tag 11.8.0 and 11.7.0 (actual doc versions) which I will include hard into the documentation, while the new file of master and later will be included by link dynamically.

michaelstingl · 2022-01-24T14:38:26Z

.github/workflows/configuration-documentation.yml

@@ -32,4 +32,4 @@ jobs:
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: Configuration documentation updated
-          file_pattern: doc/CONFIGURATION.json docs/modules/ROOT/pages/ios_mdm_tables.adoc
+          file_pattern: doc/CONFIGURATION.json doc/antora/pages/ios_mdm_tables.adoc


Please generate on 2 places:

doc/CONFIGURATION.adoc

doc/antora/pages/mdm_tables.adoc (wie MMattel will…)

A copy (double generation) of mdm_tables.adoc named doc/CONFIGURATION.adoc does not make any sense especially because you want to combine several markdown files into doc/CONFIGURATION.adoc for ios-app internal documentation purposes, see your comment: #1094 (comment). Therefore I guess this was just a mistake 😄

It is btw ok if you really want to use asciidoc (.adoc) to render ios-app internal stuff for documentation purposes, but if you do not need these capabilities, my suggestion is to stay with markdown (.md)

Nothing gets combined. Other *.md,s will just be deleted. I need the MDM content accessible in doc/CONFIGURATION.adoc. If you want to have the content in doc/antora/pages/, @hosy will add a copy for your purpose there. up2u…

michaelstingl · 2022-01-24T14:44:23Z

2 tiny additions:

Move screenshots to doc/images
enterprise/gomplate/Branding.plist.tmpl ==> move to tools folder

michaelstingl · 2022-01-24T14:47:35Z

… and can we get rid of these?

APP_BUILD_FLAGS.md
BUILD_CUSTOMIZATION.md
CONFIGURATION.md

(and unite them all in the mighty doc/CONFIGURATION.adoc)

mmattel · 2022-01-25T17:11:27Z

@hosy Just found by chance that we need an additional text change to have the correct doc link.

ios-sdk/doc/CONFIGURATION.md:18

The file located at `doc/CONFIGURATION.json` provides a machine-readable list of available settings.
For the `ios-sdk` repository, this includes only settings implemented in the SDK. For the full list of
settings available for configuration, please see
[`docs/modules/ROOT/pages/ios_mdm_tables.adoc`]
(https://github.com/owncloud/ios-app/blob/master/docs/modules/ROOT/pages/ios_mdm_tables.adoc)
in the `ios-app` repository.

- moved gomplate branding template to tools - deleted no longer needed documentation files (values are available in configuration.adoc) - renamed files - deleted antora folder - added readme file in doc folder

hosy · 2022-01-28T13:22:39Z

@mmattel @michaelstingl I did further changes in this branch, with the following changes:

moved fastlane screenshots into doc folder
moved gomplate branding template to tools
deleted no longer needed documentation files (values are available in configuration.adoc)
renamed files
deleted antora folder
added readme file in doc folder

Please have a look again. Thank you!

CLAassistant · 2022-03-29T11:54:24Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ hosy
❌ Matthias Hühne

Matthias Hühne seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

hosy · 2022-03-29T11:54:26Z

@michaelstingl merge conflict is solved and you can add your review
@mmattel please add your review too.

michaelstingl · 2022-03-29T11:56:37Z

@michaelstingl merge conflict is solved and you can add your review

This is un-reviewable. Please merge, then we'll iterate from there…

mmattel · 2022-03-31T08:57:33Z

This is un-reviewable. Please merge, then we'll iterate from there…

To proceed, pls approve (2a necessary), I did already.

michaelstingl

Let's try this… 🤞

#1070 #1082

3b3b337

- added missing link in MDM description - moved ios_mdm_tables.adoc output into new folder structure - removed no longer needed docs folder

hosy requested review from michaelstingl and mmattel January 21, 2022 13:50

hosy self-assigned this Jan 21, 2022

hosy linked an issue Jan 21, 2022 that may be closed by this pull request

[MDM] move ios_mdm_tables.adoc to doc/CONFIGURATION.adoc #1070

Closed

hosy mentioned this pull request Jan 21, 2022

Remove docs folder #1082

Closed

mmattel approved these changes Jan 21, 2022

View reviewed changes

michaelstingl reviewed Jan 24, 2022

View reviewed changes

- moved fastlane screenshots into doc folder

2d0d29d

- moved gomplate branding template to tools - deleted no longer needed documentation files (values are available in configuration.adoc) - renamed files - deleted antora folder - added readme file in doc folder

hosy requested review from mmattel and michaelstingl January 28, 2022 13:21

mmattel mentioned this pull request Jan 28, 2022

Harmonize content related to ios-app owncloud/ios-sdk#91

Open

Merge branch 'master' into docs/folder-structure

ec5c9c6

mmattel approved these changes Mar 31, 2022

View reviewed changes

Merge branch 'master' into docs/folder-structure

030c7d6

michaelstingl approved these changes Apr 4, 2022

View reviewed changes

hosy merged commit 420e5ff into master Apr 4, 2022

delete-merged-branch bot deleted the docs/folder-structure branch April 4, 2022 10:11

felix-schwarz mentioned this pull request Aug 9, 2022

[feature/graph-api] Spaces/Drives / Graph API support (WIP) #1101

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs/folder-structure] Changed Docs Structure / MDM Fixes #1094

[docs/folder-structure] Changed Docs Structure / MDM Fixes #1094

hosy commented Jan 21, 2022 •

edited by michaelstingl

Loading

mmattel commented Jan 21, 2022 •

edited

Loading

michaelstingl Jan 24, 2022

mmattel Jan 25, 2022 •

edited

Loading

michaelstingl Jan 25, 2022

michaelstingl commented Jan 24, 2022

michaelstingl commented Jan 24, 2022

mmattel commented Jan 25, 2022

hosy commented Jan 28, 2022

CLAassistant commented Mar 29, 2022

hosy commented Mar 29, 2022

michaelstingl commented Mar 29, 2022

mmattel commented Mar 31, 2022

michaelstingl left a comment

[docs/folder-structure] Changed Docs Structure / MDM Fixes #1094

[docs/folder-structure] Changed Docs Structure / MDM Fixes #1094

Conversation

hosy commented Jan 21, 2022 • edited by michaelstingl Loading

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

mmattel commented Jan 21, 2022 • edited Loading

michaelstingl Jan 24, 2022

Choose a reason for hiding this comment

mmattel Jan 25, 2022 • edited Loading

Choose a reason for hiding this comment

michaelstingl Jan 25, 2022

Choose a reason for hiding this comment

michaelstingl commented Jan 24, 2022

michaelstingl commented Jan 24, 2022

mmattel commented Jan 25, 2022

hosy commented Jan 28, 2022

CLAassistant commented Mar 29, 2022

hosy commented Mar 29, 2022

michaelstingl commented Mar 29, 2022

mmattel commented Mar 31, 2022

michaelstingl left a comment

Choose a reason for hiding this comment

hosy commented Jan 21, 2022 •

edited by michaelstingl

Loading

mmattel commented Jan 21, 2022 •

edited

Loading

mmattel Jan 25, 2022 •

edited

Loading