1dsag / ui5-best-practice Goto Github PK

This issue is for not losing the overview of the assigned topics and as a first milestone to assign them all.

This issue is for not losing the overview of the assigned topics and as a first milestone to assign them all.

• Camera , GPS , ..
• PWA

This issue is for not losing the overview of the assigned topics and as a first milestone to assign them all.

template possible from DSAG ABAP Guideline

Die Sample Main App nochmal neu aufbauen mit Linting und Best Practice

mention in README.md that a PR should be/move to draft mode, until it's either ready or finished re-worked after a code review.

In order to ensure a good general and consistent quality of the contributions there should be a review in the Github Actions.
For this purpose, a new Github action is created that checks various things.
For this severall PR are created. Here is a list in which order these PR should be merged.
Still, merge erros will probably happen.

1. Fixing Linting Errors

• #102
• #103
• #105

2. Adding Typescript

• #104

3. Linting Actions

• #106

4. Create PDFs (optional)

• #101

5. Create Documentation about Linting

• #112
• #109

Thanks to @t-kessel for setting up the sample error handler. A lot of work has gone into this. I think the code could be improved by introducing some ES6 features and applying other best practices from UI5 (e.g. no usage of sync components (like new sap.m.Button)). Would this be a welcome change or is the code like this on purpose (e.g. to run the code in IE11 without a complex babel setup)?

As a start for the CI of DSAG we can already select a logo because this is already supplied by the theme.
Also a favicon would also be useful
I have already created a template here #22

Investigate if Deno can be used instead of Node to run Typescript among other things.

ideally, they can be run within the document.
evaluate observable hq for this?

Unfortunately, no contributor was found for the topic "Encapsulation / Structuring of Code / MVC Concept".
This issue should find a sponsor for it and be linked to the pull request

@vobu writes more content for testing
@osigge review

gfm == github flavored markdown
https://github.github.com/gfm/

-> needs to go into README.md

This issue is for not losing the overview of the assigned topics and as a first milestone to assign them all.

Unfortunately, no contributor was found for the Layouts topic.
This issue should find a sponsor for it and be linked to the pull request

General possibilities in Fiori development to achieve a statefull application.
What things need to be considered there?
Possible topics that can be mentioned:
ETag
https://blogs.sap.com/2017/06/30/optimistic-locking-etag-in-sapui5/
ABAP Messaging and ABAP Push Channels
https://blogs.sap.com/2014/04/14/abap-channels-part-3-collaboration-scenario-using-abap-messaging-and-abap-push-channels

Topic List is quiet out of date
update list to see which topic are still open

This issue is for not losing the overview of the assigned topics and as a first milestone to assign them all.

Hi @vobu ,
I have seen in the documentation of our theme "Just the docs" many examples how to use CSS classes or the TOC in markdown.
So-called "Block Inline Attribute Lists" are used.
https://pmarsceill.github.io/just-the-docs/docs/navigation-structure/#in-page-navigation-with-table-of-contents
If you wanna increase the font-size for example, use using:

Font size 9
{: .fs-9 }

But since GitHub Flavored Markdown (GFM) is used in the config, these IALs cannot be utilised.
Github supports two Markdown proccessor: GFM and kramdown
After I set the Markdown processor to kramdown, it worked.

The IALs are apparently already useful and are also used by our theme.
Did you choose GFM for a special reason?

After the change to kramdown, I only noticed a few changes in the i18n area, which I would then correct.

BTP and on Premise
which Fiori Tools to use?
@osigge

Unfortunately, no contributor was found for the Patterns topic.
This issue should find a sponsor for it and be linked to the pull request

This issue is for not losing the overview of the assigned topics and as a first milestone to assign them all.

It´s currently possible that the creator can merge the PR when a review approved the changes.
That should not be possible

This issue is for not losing the overview of the assigned topics and as a first milestone to assign them all.

Besides the normal ReadMe, a Contributing Guideline should provide a better introduction for new contributors.

Unfortunately, no contributor was found for the topic "Fiori Elements vs. Free-Style".
This issue should find a sponsor for it and be linked to the pull request

• describe how to integrate a codesample --> add to readme and CLA
• Update Readme to remove Developing and Contributing because this is in contributing.md

where to store
how to use markdown
alt text

i.e.

• describe best practice to create content and how to manage metadata for the pages
• how to name the url
• numbering to order the pages
  - describe how to integrate a codesample --> add to readme and CLA

• customizing of wording
  and include in PR process

I just stumbled upon a ruby gem which can add code from github to jekyll pages:
https://github.com/bwillis/jekyll-github-sample
you can see it in action here:
https://bwillis.github.io/2014/05/28/include-github-repo-code-in-jekyll/

it does not fit in the current setup because of dependencie issues:

$ bundle add jekyll_github_sample
Fetching gem metadata from https://rubygems.org/.........
Resolving dependencies.........
Bundler could not find compatible versions for gem "activesupport":
  In snapshot (Gemfile.lock):
    activesupport (= 3.2.22.5)

  In Gemfile:
    jemoji was resolved to 0.12.0, which depends on
      html-pipeline (~> 2.2) was resolved to 2.14.0, which depends on
        activesupport (>= 2)

    jekyll_github_sample was resolved to 0.3.1, which depends on
      activesupport (~> 4.0)

Running `bundle update` will rebuild your snapshot from scratch, using only
the gems in your Gemfile, which may resolve the conflict.

it might be worth to check if it could be updated to fit in our setup.
bundler is able to install gems directly form a git repository.

also worth mentioning is the possibility to use gists: https://github.com/jekyll/jekyll-gist

How does this sound to you?

Currently a Action was created to automatically create a PDF (see #101 )
Unfortunately, when creating this PDF, it will commit to main, but in this project, main is protected.

Is may be better to run this action manually on a branch an create a PR after that.
Maybe do this on Releases

Unfortunately, no contributor was found for the topic "Anotations XML vs Backend".
This issue should find a sponsor for it and be linked to the pull request

This issue is for not losing the overview of the assigned topics and as a first milestone to assign them all.