Closed ionysos closed 4 years ago
'docs/' should be moved to Wiki
What's the motivation behind switching to the wiki? Having the docs folder in the repository with the source code allows users to read the docs w/o access to GitHub and changes can go through the usual pull request - review - merge workflow (something that is not possible out of the box for wiki content, AFAIK). If the goal is to have a docs site vs only markdown files, I think rendering docs/ into a GitHub page would be better.
max line length (for source code) should be introduced
In Go projects, source formatting and style usually is defined by gofmt
and "Effective Go" and not by the project or individual convention; the latter says:
Line length
Go has no line length limit. Don't worry about overflowing a punched card. If a line feels too long, wrap it and indent with an extra tab.
i.e. the idiomatic way is to not have a fixed line length.
@schu, thanks for your comment. We changed the wiki part accordingly.
'docs/' should be
moved to Wikipublished as Pages
The max line length should be seen more as our own convenience than a hard restriction for Go projects or similar but we will think about it again before working on the issue.
Considering the copyright headers we might go for the following to c&p:
// Copyright (C) 2019 SAP SE or an SAP affiliate company. All rights reserved.
// This file is licensed under the Apache Software License, v. 2 except as
// noted otherwise in the LICENSE file.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
only 'docs/' should be published as Pages
left
I believe that alll of the identified tasks have been solved.
Description
The project has some old, deprecated and/or unattractive contents which should be cleaned up to be more interesting and easier to understand for new contributors and/or members.
Identified points:
moved to Wikipublished as PagesUser Story
As 'project (developer) newbie' I want to get a quick and clear project overview in order to understand the goals & requirements of the project and get up and running as fast as possible.